{ "name": "Combined Specs", "children": [ { "id": 0, "name": "@supabase/supabase-js", "kind": 1, "flags": {}, "originalName": "", "children": [ { "id": 105, "name": "index", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 202, "name": "SupabaseClientOptions", "kind": 16777216, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 27, "character": 2 } ], "target": 79 }, { "id": 203, "name": "SupabaseRealtimePayload", "kind": 16777216, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 28, "character": 2 } ], "target": 92 }, { "id": 111, "name": "SupabaseClient", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "Supabase Client.", "text": "An isomorphic Javascript client for interacting with Postgres.\n" }, "children": [ { "id": 112, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 61, "character": 2 } ], "signatures": [ { "id": 113, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Create a new client for use in the browser." }, "parameters": [ { "id": 114, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 115, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 116, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 79, "name": "SupabaseClientOptions", "dereferenced": { "id": 79, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 80, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 83, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged in users." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 24, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 91, "name": "cookieOptions", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the gotrue-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "cookieOptions" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 86, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 89, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 50, "character": 2 } ], "type": { "type": "reference", "id": 78, "name": "Fetch" } }, { "id": 82, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 20, "character": 2 } ], "type": { "type": "reference", "id": 74, "name": "GenericObject" } }, { "id": 87, "name": "localStorage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 40, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "localStorage" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "multiTab", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Allows to enable/disable multi-tab/window events" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 85, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged in session to storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 88, "name": "realtime", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the realtime-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Options", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } }, { "id": 81, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 90, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Throw errors, instead of returning them." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 55, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [83, 91, 86, 89, 82, 87, 84, 85, 88, 81, 90] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 111, "name": "default" } } ] }, { "id": 117, "name": "auth", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 30, "character": 2 } ], "type": { "type": "reference", "name": "SupabaseAuthClient" } }, { "id": 121, "name": "authUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 35, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 131, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 41, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 126, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 40, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 128, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 129, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 130, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 123, "name": "functionsUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 37, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 133, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 44, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 134, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 135, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 136, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 125, "name": "multiTab", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 39, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 124, "name": "realtime", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 38, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClient", "package": "@supabase/realtime-js", "name": "default" } }, { "id": 120, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 34, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 119, "name": "restUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 33, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 118, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 32, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 132, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 42, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 122, "name": "storageUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 36, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 138, "name": "supabaseKey", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 137, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 139, "name": "functions", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 106, "character": 6 } ], "getSignature": [ { "id": 140, "name": "functions", "kind": 524288, "kindString": "Get signature", "flags": {}, "comment": { "shortText": "Supabase Functions allows you to deploy and invoke edge functions." }, "type": { "type": "reference", "qualifiedName": "FunctionsClient", "package": "@supabase/functions-js", "name": "FunctionsClient" } } ] }, { "id": 141, "name": "storage", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 116, "character": 6 } ], "getSignature": [ { "id": 142, "name": "storage", "kind": 524288, "kindString": "Get signature", "flags": {}, "comment": { "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." }, "type": { "type": "reference", "qualifiedName": "StorageClient", "package": "@supabase/storage-js", "name": "StorageClient" } } ] }, { "id": 171, "name": "_closeSubscription", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 194, "character": 16 } ], "signatures": [ { "id": 172, "name": "_closeSubscription", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 173, "name": "subscription", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RealtimeSubscription", "package": "@supabase/realtime-js", "name": "default" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 174, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 175, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 196, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [175] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 191, "name": "_getAuthHeaders", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 271, "character": 10 } ], "signatures": [ { "id": 192, "name": "_getAuthHeaders", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "id": 74, "name": "GenericObject" } } ] }, { "id": 197, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 313, "character": 10 } ], "signatures": [ { "id": 198, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 199, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "AuthChangeEvent", "package": "@supabase/gotrue-js", "name": "AuthChangeEvent" } }, { "id": 200, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 201, "name": "source", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "CLIENT" }, { "type": "literal", "value": "STORAGE" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 189, "name": "_initPostgRESTClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 262, "character": 10 } ], "signatures": [ { "id": 190, "name": "_initPostgRESTClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "qualifiedName": "PostgrestClient", "package": "@supabase/postgrest-js", "name": "default" } } ] }, { "id": 186, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 255, "character": 10 } ], "signatures": [ { "id": 187, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 188, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "Options", "package": "@supabase/realtime-js", "name": "Options" } } ], "type": { "type": "reference", "qualifiedName": "RealtimeClient", "package": "@supabase/realtime-js", "name": "default" } } ] }, { "id": 183, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 228, "character": 10 } ], "signatures": [ { "id": 184, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 185, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 79, "name": "SupabaseClientOptions", "dereferenced": { "id": 79, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 80, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 83, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged in users." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 24, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 91, "name": "cookieOptions", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the gotrue-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "cookieOptions" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 86, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 89, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 50, "character": 2 } ], "type": { "type": "reference", "id": 78, "name": "Fetch" } }, { "id": 82, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 20, "character": 2 } ], "type": { "type": "reference", "id": 74, "name": "GenericObject" } }, { "id": 87, "name": "localStorage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 40, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "localStorage" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "multiTab", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Allows to enable/disable multi-tab/window events" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 85, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged in session to storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 88, "name": "realtime", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the realtime-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Options", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } }, { "id": 81, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 90, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Throw errors, instead of returning them." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 55, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [83, 91, 86, 89, 82, 87, 84, 85, 88, 81, 90] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 36 } ] } } } } } ], "type": { "type": "reference", "name": "SupabaseAuthClient" } } ] }, { "id": 195, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 306, "character": 10 } ], "signatures": [ { "id": 196, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "qualifiedName": "Subscription", "package": "@supabase/gotrue-js", "name": "Subscription" } ] } } ] }, { "id": 193, "name": "_listenForMultiTabEvents", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 279, "character": 10 } ], "signatures": [ { "id": 194, "name": "_listenForMultiTabEvents", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "void" } ] } } ] }, { "id": 176, "name": "_unsubscribeSubscription", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 209, "character": 10 } ], "signatures": [ { "id": 177, "name": "_unsubscribeSubscription", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 178, "name": "subscription", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RealtimeSubscription", "package": "@supabase/realtime-js", "name": "default" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 180, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 211, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [180] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 143, "name": "from", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 125, "character": 2 } ], "signatures": [ { "id": 144, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a table operation." }, "typeParameter": [ { "id": 145, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "parameters": [ { "id": 146, "name": "table", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table name to operate on.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 2, "typeArguments": [ { "type": "reference", "id": 145, "name": "T" } ], "name": "SupabaseQueryBuilder" } } ] }, { "id": 181, "name": "getSubscriptions", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 224, "character": 2 } ], "signatures": [ { "id": 182, "name": "getSubscriptions", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns an array of all your subscriptions." }, "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "RealtimeSubscription", "package": "@supabase/realtime-js", "name": "default" } } } ] }, { "id": 156, "name": "removeAllSubscriptions", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 162, "character": 8 } ], "signatures": [ { "id": 157, "name": "removeAllSubscriptions", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Closes and removes all subscriptions and returns a list of removed\nsubscriptions and their errors." }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 159, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 163, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 160, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 161, "name": "subscription", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 163, "character": 14 } ], "type": { "type": "reference", "qualifiedName": "RealtimeSubscription", "package": "@supabase/realtime-js", "name": "default" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [161] } ] } } }, { "id": 162, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 163, "character": 52 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [159, 162] } ] } } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 163, "name": "removeSubscription", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 182, "character": 8 } ], "signatures": [ { "id": 164, "name": "removeSubscription", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Closes and removes a subscription and returns the number of open subscriptions." }, "parameters": [ { "id": 165, "name": "subscription", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The subscription you want to close and remove.\n" }, "type": { "type": "reference", "qualifiedName": "RealtimeSubscription", "package": "@supabase/realtime-js", "name": "default" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 166, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 167, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 184, "character": 15 } ], "type": { "type": "reflection", "declaration": { "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 169, "name": "openSubscriptions", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 184, "character": 23 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [169] } ] } } }, { "id": 170, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 184, "character": 52 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [167, 170] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 147, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 146, "character": 2 } ], "signatures": [ { "id": 148, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a function call." }, "typeParameter": [ { "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "parameters": [ { "id": 150, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The function name to call." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 151, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The parameters to pass to the function call." }, "type": { "type": "intrinsic", "name": "object" } }, { "id": 152, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 153, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 155, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 152, "character": 25 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 154, "name": "head", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 152, "character": 9 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [155, 154] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 149, "name": "T" } ], "qualifiedName": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [112] }, { "title": "Properties", "kind": 1024, "children": [ 117, 121, 131, 126, 123, 133, 125, 124, 120, 119, 118, 132, 122, 138, 137 ] }, { "title": "Accessors", "kind": 262144, "children": [139, 141] }, { "title": "Methods", "kind": 2048, "children": [171, 191, 197, 189, 186, 183, 195, 193, 176, 143, 181, 156, 163, 147] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 26, "character": 21 } ] }, { "id": 106, "name": "createClient", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 16, "character": 6 } ], "signatures": [ { "id": 107, "name": "createClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new Supabase Client." }, "parameters": [ { "id": 108, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 109, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 110, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 79, "name": "SupabaseClientOptions", "dereferenced": { "id": 79, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 80, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 83, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged in users." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 24, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 91, "name": "cookieOptions", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the gotrue-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "cookieOptions" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 86, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 89, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 50, "character": 2 } ], "type": { "type": "reference", "id": 78, "name": "Fetch" } }, { "id": 82, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 20, "character": 2 } ], "type": { "type": "reference", "id": 74, "name": "GenericObject" } }, { "id": 87, "name": "localStorage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 40, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "localStorage" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "multiTab", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Allows to enable/disable multi-tab/window events" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 85, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged in session to storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 88, "name": "realtime", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the realtime-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Options", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } }, { "id": 81, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 90, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Throw errors, instead of returning them." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 55, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [83, 91, 86, 89, 82, 87, 84, 85, 88, 81, 90] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 111, "name": "default" } } ] } ], "groups": [ { "title": "References", "kind": 16777216, "children": [202, 203] }, { "title": "Classes", "kind": 128, "children": [111] }, { "title": "Functions", "kind": 64, "children": [106] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 1, "name": "lib/SupabaseQueryBuilder", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 2, "name": "SupabaseQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 3, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 13, "character": 2 } ], "signatures": [ { "id": 4, "name": "new SupabaseQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 5, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 6, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 7, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 8, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 13, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 27, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 14, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 15, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 16, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 17, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 9, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 23, "character": 6 } ], "type": { "type": "reference", "id": 74, "name": "GenericObject" } }, { "id": 11, "name": "realtime", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 25, "character": 6 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClient", "package": "@supabase/realtime-js", "name": "default" } }, { "id": 10, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 24, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 18, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 28, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 12, "name": "table", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 26, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [13, 9, 11, 10, 18, 12] } ] } } } ], "type": { "type": "reference", "id": 2, "typeArguments": [ { "type": "reference", "id": 5, "name": "T" } ], "name": "SupabaseQueryBuilder" }, "overwrites": { "type": "reference", "name": "PostgrestQueryBuilder.constructor" } } ], "overwrites": { "type": "reference", "name": "PostgrestQueryBuilder.constructor" } }, { "id": 21, "name": "_headers", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", "id": 74, "name": "GenericObject" } }, { "id": 20, "name": "_realtime", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 8, "character": 10 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClient", "package": "@supabase/realtime-js", "name": "default" } }, { "id": 22, "name": "_schema", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 10, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 19, "name": "_subscription", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 7, "character": 10 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 33, "name": "SupabaseRealtimeClient" } ] }, "defaultValue": "null" }, { "id": 23, "name": "_table", "kind": 1024, "kindString": "Property", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 11, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 24, "name": "on", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 44, "character": 2 } ], "signatures": [ { "id": 25, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Subscribe to realtime changes in your database." }, "parameters": [ { "id": 26, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "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": 102, "name": "SupabaseEventTypes", "dereferenced": { "id": 102, "name": "SupabaseEventTypes", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 75, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INSERT" }, { "type": "literal", "value": "UPDATE" }, { "type": "literal", "value": "DELETE" }, { "type": "literal", "value": "*" } ] } } } }, { "id": 27, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A callback that will handle the payload that is sent whenever your database changes.\n" }, "type": { "type": "reflection", "declaration": { "id": 28, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 29, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 30, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 92, "typeArguments": [ { "type": "reference", "id": 5, "name": "T" } ], "name": "SupabaseRealtimePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 33, "name": "SupabaseRealtimeClient" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [3] }, { "title": "Properties", "kind": 1024, "children": [21, 20, 22, 19, 23] }, { "title": "Methods", "kind": 2048, "children": [24] } ], "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 6, "character": 13 } ], "typeParameter": [ { "id": 31, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 5, "name": "T" } ], "qualifiedName": "PostgrestQueryBuilder", "package": "@supabase/postgrest-js", "name": "default" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [2] } ], "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 32, "name": "lib/SupabaseRealtimeClient", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 33, "name": "SupabaseRealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 34, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 7, "character": 2 } ], "signatures": [ { "id": 35, "name": "new SupabaseRealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 36, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RealtimeClient", "package": "@supabase/realtime-js", "name": "default" } }, { "id": 37, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 74, "name": "GenericObject", "dereferenced": { "id": 74, "name": "GenericObject", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, "character": 28 } ], "indexSignature": { "id": 76, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 77, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } } } }, { "id": 38, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 39, "name": "tableName", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 33, "name": "SupabaseRealtimeClient" } } ] }, { "id": 40, "name": "subscription", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 5, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "RealtimeSubscription", "package": "@supabase/realtime-js", "name": "default" } }, { "id": 41, "name": "getPayloadRecords", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 19, "character": 10 } ], "signatures": [ { "id": 42, "name": "getPayloadRecords", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 43, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reflection", "declaration": { "id": 44, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 45, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 21, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 46, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } }, "defaultValue": "{}" }, { "id": 47, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 22, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } }, "defaultValue": "{}" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [45, 47] } ] } } } ] }, { "id": 49, "name": "on", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 42, "character": 2 } ], "signatures": [ { "id": 50, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The event you want to listen to." }, "parameters": [ { "id": 51, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The event" }, "type": { "type": "reference", "id": 102, "name": "SupabaseEventTypes", "dereferenced": { "id": 102, "name": "SupabaseEventTypes", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 75, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INSERT" }, { "type": "literal", "value": "UPDATE" }, { "type": "literal", "value": "DELETE" }, { "type": "literal", "value": "*" } ] } } } }, { "id": 52, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A callback function that is called whenever the event occurs.\n" }, "type": { "type": "reflection", "declaration": { "id": 53, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 54, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 55, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 92, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "SupabaseRealtimePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 33, "name": "SupabaseRealtimeClient" } } ] }, { "id": 56, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 64, "character": 2 } ], "signatures": [ { "id": 57, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Enables the subscription." }, "parameters": [ { "id": 58, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "..." } ], "type": { "type": "reference", "qualifiedName": "RealtimeSubscription", "package": "@supabase/realtime-js", "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [34] }, { "title": "Properties", "kind": 1024, "children": [40] }, { "title": "Methods", "kind": 2048, "children": [41, 49, 56] } ], "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 4, "character": 13 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [33] } ], "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 1, "character": 0 } ] }, { "id": 59, "name": "lib/constants", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 60, "name": "DEFAULT_HEADERS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/constants.ts", "line": 3, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 62, "name": "X-Client-Info", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/constants.ts", "line": 3, "character": 33 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [62] } ] } }, "defaultValue": "..." }, { "id": 63, "name": "STORAGE_KEY", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/constants.ts", "line": 4, "character": 13 } ], "type": { "type": "literal", "value": "supabase.auth.token" }, "defaultValue": "'supabase.auth.token'" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [60, 63] } ], "sources": [ { "fileName": "src/lib/constants.ts", "line": 2, "character": 0 } ] }, { "id": 64, "name": "lib/helpers", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 70, "name": "isBrowser", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/helpers.ts", "line": 15, "character": 13 } ], "signatures": [ { "id": 71, "name": "isBrowser", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 67, "name": "stripTrailingSlash", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/helpers.ts", "line": 11, "character": 16 } ], "signatures": [ { "id": 68, "name": "stripTrailingSlash", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 69, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 65, "name": "uuid", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/helpers.ts", "line": 3, "character": 16 } ], "signatures": [ { "id": 66, "name": "uuid", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] } ], "groups": [ { "title": "Functions", "kind": 64, "children": [70, 67, 65] } ], "sources": [ { "fileName": "src/lib/helpers.ts", "line": 3, "character": 0 } ] }, { "id": 72, "name": "lib/types", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 73, "name": "SupabaseAuthClientOptions", "kind": 256, "kindString": "Interface", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 6, "character": 17 } ], "extendedTypes": [ { "type": "reference", "name": "GoTrueClientOptions" } ] }, { "id": 78, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 10, "character": 12 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 14, "qualifiedName": "fetch", "package": "typescript", "name": "fetch" } } }, { "id": 74, "name": "GenericObject", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, "character": 28 } ], "indexSignature": { "id": 76, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 77, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 79, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 80, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 83, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged in users." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 24, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 91, "name": "cookieOptions", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the gotrue-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "cookieOptions" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 86, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 89, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 50, "character": 2 } ], "type": { "type": "reference", "id": 78, "name": "Fetch" } }, { "id": 82, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 20, "character": 2 } ], "type": { "type": "reference", "id": 74, "name": "GenericObject" } }, { "id": 87, "name": "localStorage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 40, "character": 2 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "localStorage" }, "objectType": { "type": "reference", "id": 73, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "multiTab", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Allows to enable/disable multi-tab/window events" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 85, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged in session to storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 88, "name": "realtime", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Options passed to the realtime-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Options", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } }, { "id": 81, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 90, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Throw errors, instead of returning them." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 55, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [83, 91, 86, 89, 82, 87, 84, 85, 88, 81, 90] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 36 } ] } } }, { "id": 102, "name": "SupabaseEventTypes", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 75, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INSERT" }, { "type": "literal", "value": "UPDATE" }, { "type": "literal", "value": "DELETE" }, { "type": "literal", "value": "*" } ] } }, { "id": 92, "name": "SupabaseRealtimePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 12 } ], "typeParameter": [ { "id": 101, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reflection", "declaration": { "id": 93, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 94, "name": "commit_timestamp", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 100, "name": "errors", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, { "type": "literal", "value": null } ] } }, { "id": 95, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INSERT" }, { "type": "literal", "value": "UPDATE" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 98, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The new record. Present for 'INSERT' and 'UPDATE' events." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, "character": 2 } ], "type": { "type": "reference", "id": 101, "name": "T" } }, { "id": 99, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The previous record. Present for 'UPDATE' and 'DELETE' events." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 71, "character": 2 } ], "type": { "type": "reference", "id": 101, "name": "T" } }, { "id": 96, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 66, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 97, "name": "table", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [94, 100, 95, 98, 99, 96, 97] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 41 } ] } } } ], "groups": [ { "title": "Interfaces", "kind": 256, "children": [73] }, { "title": "Type Aliases", "kind": 4194304, "children": [78, 74, 79, 102, 92] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 0 } ] }, { "id": 103, "name": "lib/version", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 104, "name": "version", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/version.ts", "line": 1, "character": 13 } ], "type": { "type": "literal", "value": "0.0.0-automated" }, "defaultValue": "'0.0.0-automated'" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [104] } ], "sources": [ { "fileName": "src/lib/version.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 2, "children": [105, 1, 32, 59, 64, 72, 103] } ] }, { "id": 0, "name": "@supabase/gotrue-js", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 1, "name": "GoTrueApi", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 2, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 25, "character": 2 } ], "signatures": [ { "id": 3, "name": "new GoTrueApi", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 4, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 5, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 11, "name": "cookieOptions", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 35, "character": 4 } ], "type": { "type": "reference", "id": 557, "name": "CookieOptions" } }, { "id": 12, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 36, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 13, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 14, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 15, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 16, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 7, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 32, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 8, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 9, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 10, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 6, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 31, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [11, 12, 7, 6] } ] } } } ], "type": { "type": "reference", "id": 1, "name": "default" } } ] }, { "id": 22, "name": "cookieOptions", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 22, "character": 12 } ], "type": { "type": "reference", "id": 557, "name": "CookieOptions" } }, { "id": 23, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 23, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 24, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 25, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 26, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 27, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 19, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 19, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 20, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 21, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 17, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 18, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 28, "name": "_createRequestHeaders", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 49, "character": 10 } ], "signatures": [ { "id": 29, "name": "_createRequestHeaders", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods" }, "parameters": [ { "id": 30, "name": "jwt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A valid, logged-in JWT.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reflection", "declaration": { "id": 31, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } } ] }, { "id": 32, "name": "cookieName", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 55, "character": 10 } ], "signatures": [ { "id": 33, "name": "cookieName", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 196, "name": "createUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 659, "character": 8 } ], "signatures": [ { "id": 197, "name": "createUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new user.", "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "parameters": [ { "id": 198, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The data you want to create the user with.\n" }, "type": { "type": "reference", "id": 539, "name": "AdminUserAttributes", "dereferenced": { "id": 539, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 541, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for app_metadata that.", "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 137, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 548, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 112, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" }, "inheritedFrom": { "type": "reference", "id": 538, "name": "UserAttributes.data" } }, { "id": 544, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 534, "name": "UserAttributes.email" } }, { "id": 547, "name": "email_change_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An email change token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 107, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 537, "name": "UserAttributes.email_change_token" } }, { "id": 542, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Sets if a user has confirmed their email address.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 144, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 546, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 102, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 536, "name": "UserAttributes.password" } }, { "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 535, "name": "UserAttributes.phone" } }, { "id": 543, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Sets if a user has confirmed their phone number.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 151, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 540, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata.", "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 127, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [541, 548, 544, 547, 542, 546, 545, 543, 540] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 115, "character": 17 } ], "extendedTypes": [ { "type": "reference", "id": 533, "name": "UserAttributes" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 199, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 201, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 662, "character": 18 } ], "type": { "type": "literal", "value": null } }, { "id": 202, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 662, "character": 30 } ], "type": { "type": "reference", "id": 483, "name": "ApiError" } }, { "id": 200, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 662, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [201, 202, 200] } ] } }, { "type": "reflection", "declaration": { "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 205, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 662, "character": 64 } ], "type": { "type": "reference", "id": 505, "name": "User" } }, { "id": 206, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 662, "character": 76 } ], "type": { "type": "literal", "value": null } }, { "id": 204, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 662, "character": 52 } ], "type": { "type": "reference", "id": 505, "name": "User" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [205, 206, 204] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 173, "name": "deleteAuthCookie", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 549, "character": 2 } ], "signatures": [ { "id": 174, "name": "deleteAuthCookie", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes the Auth Cookies and redirects to the" }, "parameters": [ { "id": 175, "name": "req", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The request object." }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 176, "name": "res", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The response object." }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 177, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Optionally specify a `redirectTo` URL in the options.\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 179, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 549, "character": 63 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [179] } ] } } } ], "type": { "type": "intrinsic", "name": "any" } } ] }, { "id": 241, "name": "deleteUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 799, "character": 8 } ], "signatures": [ { "id": 242, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Delete a user. Requires a `service_role` key.", "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "parameters": [ { "id": 243, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user uid you want to remove.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 244, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 246, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 801, "character": 34 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 247, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 801, "character": 53 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 245, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 801, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [246, 247, 245] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 184, "name": "generateLink", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 616, "character": 8 } ], "signatures": [ { "id": 185, "name": "generateLink", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates links to be sent via email or other." }, "parameters": [ { "id": 186, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\")." }, "type": { "type": "union", "types": [ { "type": "literal", "value": "signup" }, { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" }, { "type": "literal", "value": "recovery" }, { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } }, { "id": 187, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user's email." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 188, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 191, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 627, "character": 6 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 190, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 626, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 192, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 628, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [191, 190, 192] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 193, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 194, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 630, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 195, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 630, "character": 44 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [194, 195] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 180, "name": "getAuthCookieString", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 568, "character": 2 } ], "signatures": [ { "id": 181, "name": "getAuthCookieString", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Helper method to generate the Auth Cookie string for you in case you can't use `setAuthCookie`.", "returns": "The Cookie string that needs to be set as the value for the `Set-Cookie` header.\n" }, "parameters": [ { "id": 182, "name": "req", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The request object." }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 183, "name": "res", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The response object." }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ] }, { "id": 34, "name": "getUrlForProvider", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 65, "character": 2 } ], "signatures": [ { "id": 35, "name": "getUrlForProvider", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates the relevant login URL for a third-party provider." }, "parameters": [ { "id": 36, "name": "provider", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "type": { "type": "reference", "id": 481, "name": "Provider", "dereferenced": { "id": 481, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "bitbucket" }, { "type": "literal", "value": "discord" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "workos" } ] } } } }, { "id": 37, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 41, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 70, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 42, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 43, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 44, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 39, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 68, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 40, "name": "scopes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 69, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [41, 39, 40] } ] } } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 248, "name": "getUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 826, "character": 8 } ], "signatures": [ { "id": 249, "name": "getUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Gets the current user details.", "text": "This method is called by the GoTrueClient `update` where\nthe jwt is set to this.currentSession.access_token\nand therefore, acts like getting the currently authenticated user\n" }, "parameters": [ { "id": 250, "name": "jwt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A valid, logged-in JWT. Typically, the access_token for the currentSession\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 251, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 253, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 828, "character": 34 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 254, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 828, "character": 53 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 252, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 828, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [253, 254, 252] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 224, "name": "getUserByCookie", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 714, "character": 8 } ], "signatures": [ { "id": 225, "name": "getUserByCookie", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get user by reading the cookie from the request.\nWorks for Next.js & Express (requires cookie-parser middleware)." }, "parameters": [ { "id": 226, "name": "req", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 227, "name": "res", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 228, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 231, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 720, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 232, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 721, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 229, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 718, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 230, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 719, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [231, 232, 229, 230] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 215, "name": "getUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 697, "character": 8 } ], "signatures": [ { "id": 216, "name": "getUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get user by id." }, "parameters": [ { "id": 217, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 219, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 699, "character": 15 } ], "type": { "type": "literal", "value": null } }, { "id": 220, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 699, "character": 27 } ], "type": { "type": "reference", "id": 483, "name": "ApiError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [219, 220] } ] } }, { "type": "reflection", "declaration": { "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 222, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 699, "character": 49 } ], "type": { "type": "reference", "id": 505, "name": "User" } }, { "id": 223, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 699, "character": 61 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [222, 223] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 142, "name": "inviteUserByEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 419, "character": 8 } ], "signatures": [ { "id": 143, "name": "inviteUserByEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends an invite link to an email address." }, "parameters": [ { "id": 144, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 145, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 148, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 423, "character": 6 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 147, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 422, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [148, 147] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 149, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 150, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 425, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 151, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 425, "character": 34 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [150, 151] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 207, "name": "listUsers", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 679, "character": 8 } ], "signatures": [ { "id": 208, "name": "listUsers", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get a list of users.", "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 209, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 210, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 679, "character": 31 } ], "type": { "type": "literal", "value": null } }, { "id": 211, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 679, "character": 43 } ], "type": { "type": "reference", "id": 483, "name": "ApiError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [210, 211] } ] } }, { "type": "reflection", "declaration": { "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 213, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 679, "character": 65 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 505, "name": "User" } } }, { "id": 214, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 679, "character": 79 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [213, 214] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 163, "name": "refreshAccessToken", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 479, "character": 8 } ], "signatures": [ { "id": 164, "name": "refreshAccessToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates a new JWT." }, "parameters": [ { "id": 165, "name": "refreshToken", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A valid refresh token that was returned on login.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 166, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 167, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 481, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 168, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 481, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [167, 168] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 152, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 450, "character": 8 } ], "signatures": [ { "id": 153, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a reset request to an email address." }, "parameters": [ { "id": 154, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 155, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 156, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 158, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 454, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 157, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 453, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [158, 157] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 160, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 456, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 161, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } ] } }, { "id": 162, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 456, "character": 32 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [160, 162] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 95, "name": "sendMagicLinkEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 272, "character": 8 } ], "signatures": [ { "id": 96, "name": "sendMagicLinkEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a magic login link to an email address." }, "parameters": [ { "id": 97, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 98, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 99, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 102, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 277, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 101, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 276, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 100, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 275, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [102, 101, 100] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 104, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 279, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } ] } }, { "id": 106, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 279, "character": 32 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [104, 106] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 107, "name": "sendMobileOTP", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 310, "character": 8 } ], "signatures": [ { "id": 108, "name": "sendMobileOTP", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a mobile OTP via SMS. Will register the account if it doesn't already exist" }, "parameters": [ { "id": 109, "name": "phone", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user's phone number WITH international prefix" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 110, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 113, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 314, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 112, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 313, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [113, 112] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 114, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 115, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 316, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 116, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } ] } }, { "id": 117, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 316, "character": 32 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [115, 117] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 169, "name": "setAuthCookie", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 503, "character": 2 } ], "signatures": [ { "id": 170, "name": "setAuthCookie", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Set/delete the auth cookie based on the AuthChangeEvent.\nWorks for Next.js & Express (requires cookie-parser middleware)." }, "parameters": [ { "id": 171, "name": "req", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The request object." }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 172, "name": "res", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The response object.\n" }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 57, "name": "signInWithEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 139, "character": 8 } ], "signatures": [ { "id": 58, "name": "signInWithEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs in an existing user using their email address." }, "parameters": [ { "id": 59, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The password of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 61, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 62, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 64, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 144, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 63, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 143, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [64, 63] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 65, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 66, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 146, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 67, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 146, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [66, 67] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 89, "name": "signInWithOpenIDConnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 241, "character": 8 } ], "signatures": [ { "id": 90, "name": "signInWithOpenIDConnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs in an OpenID Connect user using their id_token." }, "parameters": [ { "id": 91, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 583, "name": "OpenIDConnectCredentials", "dereferenced": { "id": 583, "name": "OpenIDConnectCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 587, "name": "client_id", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 211, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 584, "name": "id_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 208, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 588, "name": "issuer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 212, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 585, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 209, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 586, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 210, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "Provider" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [587, 584, 588, 585, 586] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 207, "character": 17 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 92, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 93, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 247, "character": 42 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 94, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 247, "character": 64 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [93, 94] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 79, "name": "signInWithPhone", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 209, "character": 8 } ], "signatures": [ { "id": 80, "name": "signInWithPhone", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs in an existing user using their phone number and password." }, "parameters": [ { "id": 81, "name": "phone", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The phone number of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 82, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The password of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 83, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 85, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 213, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [85] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 87, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 215, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 88, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 215, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [87, 88] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 118, "name": "signOut", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 340, "character": 8 } ], "signatures": [ { "id": 119, "name": "signOut", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Removes a logged-in session." }, "parameters": [ { "id": 120, "name": "jwt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A valid, logged-in JWT.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 121, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 122, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 340, "character": 40 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [122] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 45, "name": "signUpWithEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 98, "character": 8 } ], "signatures": [ { "id": 46, "name": "signUpWithEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new user using their email address.", "returns": "A logged-in session if the server has \"autoconfirm\" ON" }, "parameters": [ { "id": 47, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 48, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The password of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 49, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 50, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 53, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 104, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 52, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 103, "character": 6 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 51, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 102, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [53, 52, 51] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 54, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 55, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 106, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 56, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 106, "character": 44 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [55, 56] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 68, "name": "signUpWithPhone", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 174, "character": 8 } ], "signatures": [ { "id": 69, "name": "signUpWithPhone", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Signs up a new user using their phone number and a password." }, "parameters": [ { "id": 70, "name": "phone", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The phone number of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 71, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The password of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 72, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 73, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 75, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 179, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 74, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 178, "character": 6 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [75, 74] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 77, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 181, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 78, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 181, "character": 44 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [77, 78] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 255, "name": "updateUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 844, "character": 8 } ], "signatures": [ { "id": 256, "name": "updateUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates the user data." }, "parameters": [ { "id": 257, "name": "jwt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A valid, logged-in JWT." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 258, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The data you want to update.\n" }, "type": { "type": "reference", "id": 533, "name": "UserAttributes", "dereferenced": { "id": 533, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 538, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 112, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 534, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 537, "name": "email_change_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An email change token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 107, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 536, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 102, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 535, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [538, 534, 537, 536, 535] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 88, "character": 17 } ], "extendedBy": [ { "type": "reference", "id": 539, "name": "AdminUserAttributes" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 259, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 261, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 847, "character": 34 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 262, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 847, "character": 53 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 260, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 847, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [261, 262, 260] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 233, "name": "updateUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 777, "character": 8 } ], "signatures": [ { "id": 234, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates the user data." }, "parameters": [ { "id": 235, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 236, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "reference", "id": 539, "name": "AdminUserAttributes", "dereferenced": { "id": 539, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 541, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for app_metadata that.", "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 137, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 548, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 112, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" }, "inheritedFrom": { "type": "reference", "id": 538, "name": "UserAttributes.data" } }, { "id": 544, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 534, "name": "UserAttributes.email" } }, { "id": 547, "name": "email_change_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An email change token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 107, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 537, "name": "UserAttributes.email_change_token" } }, { "id": 542, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Sets if a user has confirmed their email address.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 144, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 546, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 102, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 536, "name": "UserAttributes.password" } }, { "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 535, "name": "UserAttributes.phone" } }, { "id": 543, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Sets if a user has confirmed their phone number.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 151, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 540, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata.", "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 127, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [541, 548, 544, 547, 542, 546, 545, 543, 540] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 115, "character": 17 } ], "extendedTypes": [ { "type": "reference", "id": 533, "name": "UserAttributes" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 239, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 780, "character": 34 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 240, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 780, "character": 53 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 238, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 780, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [239, 240, 238] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 123, "name": "verifyMobileOTP", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 360, "character": 8 } ], "signatures": [ { "id": 124, "name": "verifyMobileOTP", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `verifyOTP` instead!" } ] }, "parameters": [ { "id": 125, "name": "phone", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user's phone number WITH international prefix" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 126, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "token that user was sent to their mobile phone" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 127, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 128, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 129, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 364, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [129] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 130, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 131, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 366, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 132, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 366, "character": 44 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [131, 132] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 133, "name": "verifyOTP", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 391, "character": 8 } ], "signatures": [ { "id": 134, "name": "verifyOTP", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Send User supplied Email / Mobile OTP to be verified" }, "parameters": [ { "id": 135, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 570, "name": "VerifyOTPParams", "dereferenced": { "id": 570, "name": "VerifyOTPParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 191, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 571, "name": "VerifyMobileOTPParams" }, { "type": "reference", "id": 576, "name": "VerifyEmailOTPParams" } ] } } } }, { "id": 136, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 137, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 138, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 394, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [138] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 139, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 140, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 396, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 141, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 396, "character": 44 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [140, 141] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [2] }, { "title": "Properties", "kind": 1024, "children": [22, 23, 18, 17] }, { "title": "Methods", "kind": 2048, "children": [ 28, 32, 196, 173, 241, 184, 180, 34, 248, 224, 215, 142, 207, 163, 152, 95, 107, 169, 57, 89, 79, 118, 45, 68, 255, 233, 123, 133 ] } ], "sources": [ { "fileName": "src/GoTrueApi.ts", "line": 17, "character": 21 } ] }, { "id": 263, "name": "GoTrueClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 264, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 82, "character": 2 } ], "signatures": [ { "id": 265, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Create a new client for use in the browser." }, "parameters": [ { "id": 266, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 267, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 274, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set to \"true\" if you want to automatically refresh the token before expiring." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 86, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 278, "name": "cookieOptions", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 90, "character": 4 } ], "type": { "type": "reference", "id": 557, "name": "CookieOptions" } }, { "id": 273, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set to \"true\" if you want to automatically detects OAuth grants in the URL and signs in the user." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 85, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 279, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 91, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 280, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 281, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "A custom fetch implementation.\n" }, "parameters": [ { "id": 282, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 283, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 269, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Any additional headers to send to the GoTrue server." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 84, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 271, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 272, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 276, "name": "localStorage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own local storage implementation to use instead of the browser's local storage." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 88, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Storage", "package": "typescript", "name": "Storage" }, { "type": "union", "types": [ { "type": "literal", "value": "getItem" }, { "type": "literal", "value": "removeItem" }, { "type": "literal", "value": "setItem" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } ], "name": "PromisifyMethods" } }, { "id": 277, "name": "multiTab", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set to \"false\" if you want to disable multi-tab/window events." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 89, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 275, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set to \"true\" if you want to automatically save the user session into local storage." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 87, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 268, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The URL of the GoTrue server." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 83, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [274, 278, 273, 279, 269, 276, 277, 275, 268] } ] } } } ], "type": { "type": "reference", "id": 263, "name": "default" } } ] }, { "id": 284, "name": "api", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 52, "character": 2 } ], "type": { "type": "reference", "id": 1, "name": "default" } }, { "id": 287, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 62, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 286, "name": "currentSession", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "comment": { "shortText": "The session object for the currently logged in user or null." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 60, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 285, "name": "currentUser", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "comment": { "shortText": "The currently logged in user or null." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 56, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 289, "name": "localStorage", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 64, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Storage", "package": "typescript", "name": "Storage" }, { "type": "union", "types": [ { "type": "literal", "value": "getItem" }, { "type": "literal", "value": "removeItem" }, { "type": "literal", "value": "setItem" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } ], "name": "PromisifyMethods" } }, { "id": 290, "name": "multiTab", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 65, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 293, "name": "networkRetries", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 68, "character": 12 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 288, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 63, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 292, "name": "refreshTokenTimer", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 67, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } }, { "id": 291, "name": "stateChangeEmitters", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 66, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "id": 549, "name": "Subscription" } ], "qualifiedName": "Map", "package": "typescript", "name": "Map" }, "defaultValue": "..." }, { "id": 454, "name": "_callRefreshToken", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 695, "character": 16 } ], "signatures": [ { "id": 455, "name": "_callRefreshToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 456, "name": "refresh_token", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 457, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 458, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "reference", "id": 486, "name": "Session" } }, { "id": 459, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 708, "character": 21 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [458, 459] } ] } }, { "type": "reflection", "declaration": { "id": 460, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 461, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 710, "character": 15 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 462, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 710, "character": 27 } ], "type": { "type": "reference", "id": 483, "name": "ApiError" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [461, 462] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 383, "name": "_handleEmailSignIn", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 520, "character": 16 } ], "signatures": [ { "id": 384, "name": "_handleEmailSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 385, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 386, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 387, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 388, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 390, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 525, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 389, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 524, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [390, 389] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 392, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 533, "character": 35 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 395, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 394, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 533, "character": 59 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 393, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 533, "character": 47 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [392, 395, 394, 393] } ] } }, { "type": "reflection", "declaration": { "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 397, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "reference", "id": 486, "name": "Session" } }, { "id": 400, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 540, "character": 53 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 399, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 540, "character": 38 } ], "type": { "type": "reference", "id": 486, "name": "Session" }, "defaultValue": "data" }, { "id": 398, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 540, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] }, "defaultValue": "data.user" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [397, 400, 399, 398] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 443, "name": "_handleOpenIDConnectSignIn", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 595, "character": 16 } ], "signatures": [ { "id": 444, "name": "_handleOpenIDConnectSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 445, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 583, "name": "OpenIDConnectCredentials", "dereferenced": { "id": 583, "name": "OpenIDConnectCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 587, "name": "client_id", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 211, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 584, "name": "id_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 208, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 588, "name": "issuer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 212, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 585, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 209, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 586, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 210, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "Provider" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [587, 584, 588, 585, 586] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 207, "character": 17 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 446, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 449, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 604, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 447, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 602, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 448, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 603, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [449, 447, 448] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 401, "name": "_handlePhoneSignIn", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 546, "character": 16 } ], "signatures": [ { "id": 402, "name": "_handlePhoneSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 403, "name": "phone", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 404, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 405, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 406, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 407, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 550, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [407] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 408, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 409, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 555, "character": 35 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 412, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 411, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 555, "character": 59 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 410, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 555, "character": 47 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [409, 412, 411, 410] } ] } }, { "type": "reflection", "declaration": { "id": 413, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 414, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "reference", "id": 486, "name": "Session" } }, { "id": 417, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 562, "character": 53 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 416, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 562, "character": 38 } ], "type": { "type": "reference", "id": 486, "name": "Session" }, "defaultValue": "data" }, { "id": 415, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 562, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] }, "defaultValue": "data.user" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [414, 417, 416, 415] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 418, "name": "_handleProviderSignIn", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 568, "character": 10 } ], "signatures": [ { "id": 419, "name": "_handleProviderSignIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 420, "name": "provider", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 481, "name": "Provider", "dereferenced": { "id": 481, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "bitbucket" }, { "type": "literal", "value": "discord" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "workos" } ] } } } }, { "id": 421, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 422, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 425, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 573, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 426, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 427, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 428, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 423, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 571, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 424, "name": "scopes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 572, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [425, 423, 424] } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 429, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 432, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 587, "character": 30 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 435, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 587, "character": 69 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 430, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "reference", "id": 481, "name": "Provider" } }, { "id": 433, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 587, "character": 42 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 431, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 434, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 587, "character": 57 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [432, 435, 430, 433, 431, 434] } ] } }, { "type": "reflection", "declaration": { "id": 436, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 437, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 591, "character": 15 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 440, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 591, "character": 54 } ], "type": { "type": "reference", "id": 483, "name": "ApiError" }, "defaultValue": "..." }, { "id": 441, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 439, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 591, "character": 39 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 442, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 438, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 591, "character": 27 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [437, 440, 441, 439, 442, 438] } ] } } ] } } ] }, { "id": 479, "name": "_handleVisibilityChange", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 800, "character": 10 } ], "signatures": [ { "id": 480, "name": "_handleVisibilityChange", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "literal", "value": false } ] } } ] }, { "id": 477, "name": "_listenForMultiTabEvents", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 777, "character": 10 } ], "signatures": [ { "id": 478, "name": "_listenForMultiTabEvents", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Listens for changes to LocalStorage and updates the current session." }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "literal", "value": false } ] } } ] }, { "id": 463, "name": "_notifyAllSubscribers", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 714, "character": 10 } ], "signatures": [ { "id": 464, "name": "_notifyAllSubscribers", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 465, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 482, "name": "AuthChangeEvent", "dereferenced": { "id": 482, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "PASSWORD_RECOVERY" }, { "type": "literal", "value": "SIGNED_IN" }, { "type": "literal", "value": "SIGNED_OUT" }, { "type": "literal", "value": "TOKEN_REFRESHED" }, { "type": "literal", "value": "USER_UPDATED" }, { "type": "literal", "value": "USER_DELETED" } ] } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 469, "name": "_persistSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 741, "character": 10 } ], "signatures": [ { "id": 470, "name": "_persistSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 471, "name": "currentSession", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 486, "name": "Session", "dereferenced": { "id": 486, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 488, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 34, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 490, "name": "expires_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 42, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 489, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 487, "name": "provider_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 33, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 491, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 492, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 44, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 493, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [488, 490, 489, 487, 491, 492, 493] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 17 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 452, "name": "_recoverAndRefresh", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 650, "character": 16 } ], "signatures": [ { "id": 453, "name": "_recoverAndRefresh", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Recovers the session from LocalStorage and refreshes\nNote: this method is async to accommodate for AsyncStorage e.g. in React native." }, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "literal", "value": null } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 450, "name": "_recoverSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 630, "character": 10 } ], "signatures": [ { "id": 451, "name": "_recoverSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Attempts to get the session from LocalStorage\nNote: this should never be async (even for React Native), as we need it to return immediately in the constructor." }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "literal", "value": null } ] } } ] }, { "id": 472, "name": "_removeSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 746, "character": 16 } ], "signatures": [ { "id": 473, "name": "_removeSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 466, "name": "_saveSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 722, "character": 10 } ], "signatures": [ { "id": 467, "name": "_saveSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible" }, "parameters": [ { "id": 468, "name": "session", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 486, "name": "Session", "dereferenced": { "id": 486, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 488, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 34, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 490, "name": "expires_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 42, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 489, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 487, "name": "provider_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 33, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 491, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 492, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 44, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 493, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [488, 490, 489, 487, 491, 492, 493] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 17 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 474, "name": "_startAutoRefreshToken", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 757, "character": 10 } ], "signatures": [ { "id": 475, "name": "_startAutoRefreshToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Clear and re-create refresh token timer" }, "parameters": [ { "id": 476, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "time intervals in milliseconds\n" }, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 361, "name": "getSessionFromUrl", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 428, "character": 8 } ], "signatures": [ { "id": 362, "name": "getSessionFromUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Gets the session data from a URL string" }, "parameters": [ { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 365, "name": "storeSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optionally store the session in the browser\n" }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 429, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [365] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 366, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 367, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 430, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 368, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 430, "character": 38 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [367, 368] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 373, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 500, "character": 2 } ], "signatures": [ { "id": 374, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Receive a notification every time an auth event happens.", "returns": "A subscription object which can be used to unsubscribe itself.\n" }, "parameters": [ { "id": 375, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 376, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 377, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 378, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 482, "name": "AuthChangeEvent" } }, { "id": 379, "name": "session", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 381, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 501, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 549, "name": "Subscription" } ] } }, { "id": 382, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 502, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [381, 382] } ] } } } ] }, { "id": 339, "name": "refreshSession", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 339, "character": 8 } ], "signatures": [ { "id": 340, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Force refreshes the session including the user data in case it was updated in a different session." }, "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 342, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 340, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 344, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 342, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 343, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 341, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [342, 344, 343] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 337, "name": "session", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 332, "character": 2 } ], "signatures": [ { "id": 338, "name": "session", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the session data, if there is an active session." }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } } ] }, { "id": 358, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 411, "character": 2 } ], "signatures": [ { "id": 359, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Overrides the JWT on the current client. The JWT will then be sent in all subsequent network requests." }, "parameters": [ { "id": 360, "name": "access_token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "a jwt access token\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 486, "name": "Session" } } ] }, { "id": 352, "name": "setSession", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 387, "character": 8 } ], "signatures": [ { "id": 353, "name": "setSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the session data from refresh_token and returns current Session and Error" }, "parameters": [ { "id": 354, "name": "refresh_token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "a JWT token\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 389, "character": 40 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 356, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 389, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357, 356] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 306, "name": "signIn", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 197, "character": 8 } ], "signatures": [ { "id": 307, "name": "signIn", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Log in an existing user, or login via a third-party provider." }, "parameters": [ { "id": 308, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 563, "name": "UserCredentials", "dereferenced": { "id": 563, "name": "UserCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 564, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 182, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 569, "name": "oidc", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 188, "character": 2 } ], "type": { "type": "reference", "id": 583, "name": "OpenIDConnectCredentials" } }, { "id": 566, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 184, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 565, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 183, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 568, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 187, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "Provider" } }, { "id": 567, "name": "refreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 185, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [564, 569, 566, 565, 568, 567] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 181, "character": 17 } ] } } }, { "id": 309, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 310, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 314, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 203, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 315, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 204, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 316, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 317, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 318, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 311, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 200, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 313, "name": "scopes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 202, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 312, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 201, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [314, 315, 311, 313, 312] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 319, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 324, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 211, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 322, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 209, "character": 4 } ], "type": { "type": "reference", "id": 481, "name": "Provider" } }, { "id": 320, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 207, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 323, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 210, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 321, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 208, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [324, 322, 320, 323, 321] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 369, "name": "signOut", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 485, "character": 8 } ], "signatures": [ { "id": 370, "name": "signOut", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a \"SIGNED_OUT\" event.", "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`. There is no way to revoke a user's session JWT before it automatically expires\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 371, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 372, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 485, "character": 29 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [372] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 294, "name": "signUp", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 130, "character": 8 } ], "signatures": [ { "id": 295, "name": "signUp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new user." }, "parameters": [ { "id": 296, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 563, "name": "UserCredentials", "dereferenced": { "id": 563, "name": "UserCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 564, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 182, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 569, "name": "oidc", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 188, "character": 2 } ], "type": { "type": "reference", "id": 583, "name": "OpenIDConnectCredentials" } }, { "id": 566, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 184, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 565, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 183, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 568, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 187, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "Provider" } }, { "id": 567, "name": "refreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 185, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [564, 569, 566, 565, 568, 567] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 181, "character": 17 } ] } } }, { "id": 297, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 298, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 301, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 135, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 300, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 134, "character": 6 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 299, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 133, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [301, 300, 299] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 302, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 305, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 140, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 304, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 139, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 303, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 138, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [305, 304, 303] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 345, "name": "update", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 360, "character": 8 } ], "signatures": [ { "id": 346, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates user data, if there is a logged in user." }, "parameters": [ { "id": 347, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 533, "name": "UserAttributes", "dereferenced": { "id": 533, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 538, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 112, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 534, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 537, "name": "email_change_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An email change token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 107, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 536, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 102, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 535, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [538, 534, 537, 536, 535] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 88, "character": 17 } ], "extendedBy": [ { "type": "reference", "id": 539, "name": "AdminUserAttributes" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 362, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } }, { "id": 351, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 362, "character": 53 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 350, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 362, "character": 34 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349, 351, 350] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 335, "name": "user", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 325, "character": 2 } ], "signatures": [ { "id": 336, "name": "user", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Inside a browser context, `user()` will return the user data, if there is a logged in user.", "text": "For server-side management, you can get a user through `auth.api.getUserByCookie()`\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ] }, { "id": 325, "name": "verifyOTP", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 277, "character": 8 } ], "signatures": [ { "id": 326, "name": "verifyOTP", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Log in a user given a User supplied OTP received via mobile." }, "parameters": [ { "id": 327, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 570, "name": "VerifyOTPParams", "dereferenced": { "id": 570, "name": "VerifyOTPParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 191, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 571, "name": "VerifyMobileOTPParams" }, { "type": "reference", "id": 576, "name": "VerifyEmailOTPParams" } ] } } } }, { "id": 328, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 330, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 280, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [330] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 331, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 334, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 285, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 483, "name": "ApiError" } ] } }, { "id": 333, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 284, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } }, { "id": 332, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 283, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [334, 333, 332] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [264] }, { "title": "Properties", "kind": 1024, "children": [284, 287, 286, 285, 289, 290, 293, 288, 292, 291] }, { "title": "Methods", "kind": 2048, "children": [ 454, 383, 443, 401, 418, 479, 477, 463, 469, 452, 450, 472, 466, 474, 361, 373, 339, 337, 358, 352, 306, 369, 294, 345, 335, 325 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 47, "character": 21 } ] }, { "id": 539, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 541, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for app_metadata that.", "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 137, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 548, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 112, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" }, "inheritedFrom": { "type": "reference", "id": 538, "name": "UserAttributes.data" } }, { "id": 544, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 534, "name": "UserAttributes.email" } }, { "id": 547, "name": "email_change_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An email change token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 107, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 537, "name": "UserAttributes.email_change_token" } }, { "id": 542, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Sets if a user has confirmed their email address.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 144, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 546, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 102, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 536, "name": "UserAttributes.password" } }, { "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 535, "name": "UserAttributes.phone" } }, { "id": 543, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Sets if a user has confirmed their phone number.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 151, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 540, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata.", "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 127, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [541, 548, 544, 547, 542, 546, 545, 543, 540] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 115, "character": 17 } ], "extendedTypes": [ { "type": "reference", "id": 533, "name": "UserAttributes" } ] }, { "id": 483, "name": "ApiError", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 484, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 485, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 29, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [484, 485] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 27, "character": 17 } ] }, { "id": 557, "name": "CookieOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 560, "name": "domain", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 175, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 559, "name": "lifetime", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 173, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 558, "name": "name", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 171, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 561, "name": "path", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 176, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 562, "name": "sameSite", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 178, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [560, 559, 558, 561, 562] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 169, "character": 17 } ] }, { "id": 583, "name": "OpenIDConnectCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 587, "name": "client_id", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 211, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 584, "name": "id_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 208, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 588, "name": "issuer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 212, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 585, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 209, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 586, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 210, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "Provider" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [587, 584, 588, 585, 586] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 207, "character": 17 } ] }, { "id": 486, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 488, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 34, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 490, "name": "expires_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 42, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 489, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 487, "name": "provider_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 33, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 491, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 492, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 44, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 493, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 505, "name": "User" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [488, 490, 489, 487, 491, 492, 493] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 17 } ] }, { "id": 549, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 550, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The subscriber UUID. This will be set by the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 158, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 551, "name": "callback", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 162, "character": 2 } ], "signatures": [ { "id": 552, "name": "callback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The function to call every time there is an event. eg: (eventName) => {}" }, "parameters": [ { "id": 553, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 482, "name": "AuthChangeEvent", "dereferenced": { "id": 482, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "PASSWORD_RECOVERY" }, { "type": "literal", "value": "SIGNED_IN" }, { "type": "literal", "value": "SIGNED_OUT" }, { "type": "literal", "value": "TOKEN_REFRESHED" }, { "type": "literal", "value": "USER_UPDATED" }, { "type": "literal", "value": "USER_DELETED" } ] } } } }, { "id": 554, "name": "session", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 486, "name": "Session" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 555, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 166, "character": 2 } ], "signatures": [ { "id": 556, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Call this to remove the listener." }, "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [550] }, { "title": "Methods", "kind": 2048, "children": [551, 555] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 154, "character": 17 } ] }, { "id": 505, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 522, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 75, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 507, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 62, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 508, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 509, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [509] } ], "indexSignature": { "id": 510, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 511, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 516, "name": "aud", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 517, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 70, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 526, "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 79, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 525, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 78, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 523, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 519, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 527, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 506, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 61, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 532, "name": "identities", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 85, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 494, "name": "UserIdentity" } } }, { "id": 521, "name": "invited_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 529, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "new_email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 524, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 77, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 528, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 81, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 518, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 530, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 83, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 531, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 84, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 66, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 513, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 514, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 515, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 522, 507, 516, 517, 526, 525, 523, 519, 527, 506, 532, 521, 529, 520, 524, 528, 518, 530, 531, 512 ] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 17 } ] }, { "id": 533, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 538, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 112, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 534, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 537, "name": "email_change_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An email change token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 107, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 536, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 102, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 535, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [538, 534, 537, 536, 535] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 88, "character": 17 } ], "extendedBy": [ { "type": "reference", "id": 539, "name": "AdminUserAttributes" } ] }, { "id": 563, "name": "UserCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 564, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 182, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 569, "name": "oidc", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 188, "character": 2 } ], "type": { "type": "reference", "id": 583, "name": "OpenIDConnectCredentials" } }, { "id": 566, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 184, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 565, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 183, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 568, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 187, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "Provider" } }, { "id": 567, "name": "refreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 185, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [564, 569, 566, 565, 568, 567] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 181, "character": 17 } ] }, { "id": 494, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 502, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 55, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 495, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 49, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 497, "name": "identity_data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 51, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 498, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 499, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 500, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 503, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 501, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 504, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 57, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 496, "name": "user_id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 50, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [502, 495, 497, 503, 501, 504, 496] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, "character": 17 } ] }, { "id": 576, "name": "VerifyEmailOTPParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 577, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 199, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 578, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 200, "character": 2 } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 579, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 201, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 580, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 202, "character": 2 } ], "type": { "type": "reference", "id": 582, "name": "EmailOTPType" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [577, 578, 579, 580] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 198, "character": 17 } ] }, { "id": 571, "name": "VerifyMobileOTPParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 572, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 193, "character": 2 } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 573, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 194, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 574, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 195, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 575, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 196, "character": 2 } ], "type": { "type": "reference", "id": 581, "name": "MobileOTPType" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [572, 573, 574, 575] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 192, "character": 17 } ] }, { "id": 482, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "PASSWORD_RECOVERY" }, { "type": "literal", "value": "SIGNED_IN" }, { "type": "literal", "value": "SIGNED_OUT" }, { "type": "literal", "value": "TOKEN_REFRESHED" }, { "type": "literal", "value": "USER_UPDATED" }, { "type": "literal", "value": "USER_DELETED" } ] } }, { "id": 582, "name": "EmailOTPType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 205, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "signup" }, { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" }, { "type": "literal", "value": "recovery" }, { "type": "literal", "value": "email_change" } ] } }, { "id": 581, "name": "MobileOTPType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 204, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } }, { "id": 481, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "bitbucket" }, { "type": "literal", "value": "discord" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "workos" } ] } }, { "id": 589, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 224, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Storage", "package": "typescript", "name": "Storage" }, { "type": "union", "types": [ { "type": "literal", "value": "getItem" }, { "type": "literal", "value": "setItem" }, { "type": "literal", "value": "removeItem" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } ], "name": "PromisifyMethods" } }, { "id": 570, "name": "VerifyOTPParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 191, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 571, "name": "VerifyMobileOTPParams" }, { "type": "reference", "id": 576, "name": "VerifyEmailOTPParams" } ] } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [1, 263] }, { "title": "Interfaces", "kind": 256, "children": [539, 483, 557, 583, 486, 549, 505, 533, 563, 494, 576, 571] }, { "title": "Type Aliases", "kind": 4194304, "children": [482, 582, 581, 481, 589, 570] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 0, "name": "@supabase/postgrest-js", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 502, "name": "\"PostgrestClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/PostgrestClient.ts", "children": [ { "id": 503, "name": "PostgrestClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 512, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Creates a PostgREST client." }, "signatures": [ { "id": 513, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Creates a PostgREST client." }, "parameters": [ { "id": 514, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "URL of the PostgREST endpoint." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 515, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 516, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 522, "name": "fetch", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 26, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "id": 375, "name": "fetch" } ] } }, { "id": 517, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Custom headers." }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 24, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 519, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 520, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 521, "name": "schema", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Postgres schema to switch to.\n" }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 25, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 523, "name": "throwOnError", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 27, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [522, 517, 521, 523] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 22, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 503, "name": "PostgrestClient" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 12, "character": 30 } ] }, { "id": 510, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 11, "character": 7 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" } }, { "id": 505, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 9, "character": 9 } ], "type": { "type": "reflection", "declaration": { "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 507, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 508, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 9, "character": 10 } ] } } }, { "id": 509, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 10, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 511, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 12, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } }, { "id": 504, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 8, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 524, "name": "auth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 525, "name": "auth", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Authenticates the request with JWT." }, "parameters": [ { "id": 526, "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": 47, "character": 6 } ] }, { "id": 527, "name": "from", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 528, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a table operation." }, "typeParameter": [ { "id": 529, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 530, "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": 363, "typeArguments": [ { "type": "typeParameter", "name": "T", "default": { "type": "intrinsic", "name": "any" } } ], "name": "PostgrestQueryBuilder" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 57, "character": 6 } ] }, { "id": 531, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 532, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a function call." }, "typeParameter": [ { "id": 533, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 534, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The function name to call." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 535, "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": 536, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 539, "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": 80, "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": 538, "name": "head", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "When set to true, no data will be returned." }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 79, "character": 10 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [539, 538] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 77, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T", "default": { "type": "intrinsic", "name": "any" } } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 75, "character": 5 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [512] }, { "title": "Properties", "kind": 1024, "children": [510, 505, 509, 511, 504] }, { "title": "Methods", "kind": 2048, "children": [524, 527, 531] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 7, "character": 36 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [503] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 1, "character": 0 } ] }, { "id": 540, "name": "\"index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/index.ts", "sources": [ { "fileName": "index.ts", "line": 1, "character": 0 } ] }, { "id": 149, "name": "\"lib/PostgrestFilterBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/lib/PostgrestFilterBuilder.ts", "children": [ { "id": 150, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 151, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 343, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 344, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 345, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder", "dereferenced": { "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": 41, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 42, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 43, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder", "dereferenced": "[Circular ~.children.2.children.0.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", "id": 27, "name": "PostgrestBuilder" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 31 } ] }, { "id": 40, "name": "allowEmpty", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "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": 39, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 59, "character": 17 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" } }, { "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 }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 38, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 58, "character": 18 } ], "type": { "type": "reference", "name": "AbortSignal" } }, { "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": 47, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 48, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 49, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 50, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 51, "name": "onfulfilled", "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": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 66, "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": 93, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 55, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 57, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 58, "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": 96, "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": 91, "character": 6 } ] }, { "id": 44, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 45, "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" }, "parameters": [ { "id": 46, "name": "throwOnError", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 83, "character": 14 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [41] }, { "title": "Properties", "kind": 1024, "children": [40, 36, 39, 31, 29, 35, 37, 38, 30] }, { "title": "Methods", "kind": 2048, "children": [47, 44] } ], "sources": [ { "fileName": "lib/types.ts", "line": 51, "character": 38 } ], "extendedBy": [ { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder" }, { "type": "reference", "id": 363, "name": "PostgrestQueryBuilder" }, { "type": "reference", "id": 449, "name": "PostgrestRpcBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } } } ], "type": { "type": "reference", "id": 150, "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 31 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } }, { "id": 237, "name": "adj", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeAdjacent()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 328, "character": 5 } ], "type": { "type": "reference", "id": 233, "name": "rangeAdjacent" }, "defaultValue": "this.rangeAdjacent" }, { "id": 342, "name": "allowEmpty", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 40, "name": "PostgrestBuilder.allowEmpty" } }, { "id": 338, "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": 212, "name": "cd", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `containedBy()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 253, "character": 4 } ], "type": { "type": "reference", "id": 208, "name": "containedBy" }, "defaultValue": "this.containedBy" }, { "id": 207, "name": "cs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `contains()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 229, "character": 4 } ], "type": { "type": "reference", "id": 203, "name": "contains" }, "defaultValue": "this.contains" }, { "id": 341, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 59, "character": 17 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" }, "inheritedFrom": { "type": "reference", "id": 39, "name": "PostgrestBuilder.fetch" } }, { "id": 333, "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": 334, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 335, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 336, "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": 331, "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": 227, "name": "nxl", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeGte()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 298, "character": 5 } ], "type": { "type": "reference", "id": 223, "name": "rangeGte" }, "defaultValue": "this.rangeGte" }, { "id": 232, "name": "nxr", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeLte()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 313, "character": 5 } ], "type": { "type": "reference", "id": 228, "name": "rangeLte" }, "defaultValue": "this.rangeLte" }, { "id": 242, "name": "ov", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `overlaps()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 349, "character": 4 } ], "type": { "type": "reference", "id": 238, "name": "overlaps" }, "defaultValue": "this.overlaps" }, { "id": 337, "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": 339, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 340, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 58, "character": 18 } ], "type": { "type": "reference", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.signal" } }, { "id": 217, "name": "sl", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeLt()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 268, "character": 4 } ], "type": { "type": "reference", "id": 213, "name": "rangeLt" }, "defaultValue": "this.rangeLt" }, { "id": 222, "name": "sr", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeGt()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 283, "character": 4 } ], "type": { "type": "reference", "id": 218, "name": "rangeGt" }, "defaultValue": "this.rangeGt" }, { "id": 332, "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": 311, "name": "abortSignal", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 312, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Sets the AbortSignal for the fetch request." }, "parameters": [ { "id": 313, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "AbortSignal" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 99, "name": "PostgrestTransformBuilder.abortSignal" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 91, "character": 13 } ], "inheritedFrom": { "type": "reference", "id": 99, "name": "PostgrestTransformBuilder.abortSignal" } }, { "id": 208, "name": "containedBy", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 209, "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": 210, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 211, "name": "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": 238, "character": 13 } ] }, { "id": 203, "name": "contains", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 204, "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": 205, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 206, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } }, { "type": "intrinsic", "name": "object" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 213, "character": 10 } ] }, { "id": 318, "name": "csv", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 319, "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": 68, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 106, "name": "PostgrestTransformBuilder.csv" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 119, "character": 5 } ], "inheritedFrom": { "type": "reference", "id": 106, "name": "PostgrestTransformBuilder.csv" } }, { "id": 163, "name": "eq", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 164, "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": 165, "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": 166, "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": 85, "character": 4 } ] }, { "id": 322, "name": "explain", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 323, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Obtains the EXPLAIN plan for this request." }, "parameters": [ { "id": 324, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 326, "name": "analyze", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, the query will be executed and the actual run time will be displayed." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 142, "character": 11 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 329, "name": "buffers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, include information on buffer usage." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 145, "character": 11 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 328, "name": "settings", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, include information on configuration parameters that affect query planning." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 144, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 327, "name": "verbose", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, the query identifier will be displayed and the result will include the output columns of the query." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 143, "character": 11 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 330, "name": "wal", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, include information on WAL record generation\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 146, "character": 7 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [326, 329, 328, 327, 330] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 141, "character": 10 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 110, "name": "PostgrestTransformBuilder.explain" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 141, "character": 9 } ], "inheritedFrom": { "type": "reference", "id": 110, "name": "PostgrestTransformBuilder.explain" } }, { "id": 279, "name": "filter", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 280, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose `column` satisfies the filter." }, "parameters": [ { "id": 281, "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": 282, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The operator to filter with." }, "type": { "type": "reference", "id": 361, "name": "FilterOperator", "dereferenced": { "id": 361, "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" }, { "type": "stringLiteral", "value": "not.eq" }, { "type": "stringLiteral", "value": "not.neq" }, { "type": "stringLiteral", "value": "not.gt" }, { "type": "stringLiteral", "value": "not.gte" }, { "type": "stringLiteral", "value": "not.lt" }, { "type": "stringLiteral", "value": "not.lte" }, { "type": "stringLiteral", "value": "not.like" }, { "type": "stringLiteral", "value": "not.ilike" }, { "type": "stringLiteral", "value": "not.is" }, { "type": "stringLiteral", "value": "not.in" }, { "type": "stringLiteral", "value": "not.cs" }, { "type": "stringLiteral", "value": "not.cd" }, { "type": "stringLiteral", "value": "not.sl" }, { "type": "stringLiteral", "value": "not.sr" }, { "type": "stringLiteral", "value": "not.nxl" }, { "type": "stringLiteral", "value": "not.nxr" }, { "type": "stringLiteral", "value": "not.adj" }, { "type": "stringLiteral", "value": "not.ov" }, { "type": "stringLiteral", "value": "not.fts" }, { "type": "stringLiteral", "value": "not.plfts" }, { "type": "stringLiteral", "value": "not.phfts" }, { "type": "stringLiteral", "value": "not.wfts" } ] } } } }, { "id": 283, "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": 452, "character": 8 } ] }, { "id": 251, "name": "fts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 252, "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": 253, "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": 254, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 255, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 256, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 257, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 391, "character": 46 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [257] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 391, "character": 37 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 391, "character": 5 } ] }, { "id": 320, "name": "geojson", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 321, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set the response type to GeoJSON." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 68, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 108, "name": "PostgrestTransformBuilder.geojson" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 127, "character": 9 } ], "inheritedFrom": { "type": "reference", "id": 108, "name": "PostgrestTransformBuilder.geojson" } }, { "id": 171, "name": "gt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 172, "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": 173, "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": 174, "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": 109, "character": 4 } ] }, { "id": 175, "name": "gte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 176, "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": 177, "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": 178, "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": 121, "character": 5 } ] }, { "id": 191, "name": "ilike", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 192, "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": 193, "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": 194, "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": 169, "character": 7 } ] }, { "id": 199, "name": "in", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 200, "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": 201, "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": 202, "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": 193, "character": 4 } ] }, { "id": 195, "name": "is", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 196, "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": 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": "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": 181, "character": 4 } ] }, { "id": 187, "name": "like", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 188, "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": 189, "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": 190, "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": 157, "character": 6 } ] }, { "id": 298, "name": "limit", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 299, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result with the specified `count`." }, "parameters": [ { "id": 300, "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": 301, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 302, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 303, "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": [303] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 22 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 86, "name": "PostgrestTransformBuilder.limit" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 86, "name": "PostgrestTransformBuilder.limit" } }, { "id": 179, "name": "lt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 180, "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": 181, "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": 182, "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": 133, "character": 4 } ] }, { "id": 183, "name": "lte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 184, "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": 185, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 186, "name": "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": 145, "character": 5 } ] }, { "id": 284, "name": "match", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 285, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose columns match the specified `query` object." }, "parameters": [ { "id": 286, "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": 463, "character": 7 } ] }, { "id": 316, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 317, "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": 70, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestMaybeSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 104, "name": "PostgrestTransformBuilder.maybeSingle" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 110, "character": 13 } ], "inheritedFrom": { "type": "reference", "id": 104, "name": "PostgrestTransformBuilder.maybeSingle" } }, { "id": 167, "name": "neq", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 168, "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": 169, "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": 170, "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": 97, "character": 5 } ] }, { "id": 152, "name": "not", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 153, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows which doesn't satisfy the filter." }, "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": "operator", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The operator to filter with." }, "type": { "type": "reference", "id": 361, "name": "FilterOperator", "dereferenced": { "id": 361, "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" }, { "type": "stringLiteral", "value": "not.eq" }, { "type": "stringLiteral", "value": "not.neq" }, { "type": "stringLiteral", "value": "not.gt" }, { "type": "stringLiteral", "value": "not.gte" }, { "type": "stringLiteral", "value": "not.lt" }, { "type": "stringLiteral", "value": "not.lte" }, { "type": "stringLiteral", "value": "not.like" }, { "type": "stringLiteral", "value": "not.ilike" }, { "type": "stringLiteral", "value": "not.is" }, { "type": "stringLiteral", "value": "not.in" }, { "type": "stringLiteral", "value": "not.cs" }, { "type": "stringLiteral", "value": "not.cd" }, { "type": "stringLiteral", "value": "not.sl" }, { "type": "stringLiteral", "value": "not.sr" }, { "type": "stringLiteral", "value": "not.nxl" }, { "type": "stringLiteral", "value": "not.nxr" }, { "type": "stringLiteral", "value": "not.adj" }, { "type": "stringLiteral", "value": "not.ov" }, { "type": "stringLiteral", "value": "not.fts" }, { "type": "stringLiteral", "value": "not.plfts" }, { "type": "stringLiteral", "value": "not.phfts" }, { "type": "stringLiteral", "value": "not.wfts" } ] } } } }, { "id": 156, "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": 61, "character": 5 } ] }, { "id": 157, "name": "or", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 158, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows satisfying at least one of the filters." }, "parameters": [ { "id": 159, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The filters to use, separated by commas." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 160, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 161, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 162, "name": "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": 72, "character": 36 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [162] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 72, "character": 21 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 72, "character": 4 } ] }, { "id": 290, "name": "order", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 291, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Orders the result with the specified `column`." }, "parameters": [ { "id": 292, "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": 293, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 294, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 295, "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": 297, "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": 296, "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": [295, 297, 296] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 41, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 78, "name": "PostgrestTransformBuilder.order" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 40, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 78, "name": "PostgrestTransformBuilder.order" } }, { "id": 238, "name": "overlaps", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 239, "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": 240, "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": 241, "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": 337, "character": 10 } ] }, { "id": 265, "name": "phfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 266, "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": 267, "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": 268, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 269, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 271, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 423, "character": 48 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [271] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 423, "character": 39 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 423, "character": 7 } ] }, { "id": 258, "name": "plfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 259, "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": 260, "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": 261, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 262, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 263, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 264, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 407, "character": 48 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [264] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 407, "character": 39 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 407, "character": 7 } ] }, { "id": 304, "name": "range", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 305, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result to rows within the specified range, inclusive." }, "parameters": [ { "id": 306, "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": 307, "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": 308, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 309, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 310, "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": [310] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 33 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 92, "name": "PostgrestTransformBuilder.range" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 92, "name": "PostgrestTransformBuilder.range" } }, { "id": 233, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 234, "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": 235, "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": 236, "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": 322, "character": 15 } ] }, { "id": 218, "name": "rangeGt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 219, "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": 220, "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": 221, "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": 277, "character": 9 } ] }, { "id": 223, "name": "rangeGte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 224, "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": 225, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 226, "name": "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": 292, "character": 10 } ] }, { "id": 213, "name": "rangeLt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 214, "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": 215, "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": 216, "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": 262, "character": 9 } ] }, { "id": 228, "name": "rangeLte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 229, "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": 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": "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": 307, "character": 10 } ] }, { "id": 287, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 288, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 289, "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": 75, "name": "PostgrestTransformBuilder.select" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 13, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 75, "name": "PostgrestTransformBuilder.select" } }, { "id": 314, "name": "single", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 315, "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": 68, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 102, "name": "PostgrestTransformBuilder.single" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 100, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 102, "name": "PostgrestTransformBuilder.single" } }, { "id": 243, "name": "textSearch", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 244, "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": 245, "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": 246, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 247, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 248, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 249, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use." }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 364, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 250, "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": 365, "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": [249, 250] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 362, "character": 18 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 360, "character": 12 } ] }, { "id": 349, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 350, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 351, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 352, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 353, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 354, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 355, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 356, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 66, "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": 93, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 357, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 358, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 359, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 360, "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": 96, "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": 47, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 91, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 47, "name": "PostgrestBuilder.then" } }, { "id": 346, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 347, "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" }, "parameters": [ { "id": 348, "name": "throwOnError", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 83, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } }, { "id": 272, "name": "wfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 273, "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": 274, "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": 275, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 276, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 277, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 278, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 439, "character": 47 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [278] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 439, "character": 38 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 439, "character": 6 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [343] }, { "title": "Properties", "kind": 1024, "children": [ 237, 342, 338, 212, 207, 341, 333, 331, 227, 232, 242, 337, 339, 340, 217, 222, 332 ] }, { "title": "Methods", "kind": 2048, "children": [ 311, 208, 203, 318, 163, 322, 279, 251, 320, 171, 175, 191, 199, 195, 187, 298, 179, 183, 284, 316, 167, 152, 157, 290, 238, 265, 258, 304, 233, 218, 223, 213, 228, 287, 314, 243, 349, 346, 272 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 53, "character": 43 } ], "extendedTypes": [ { "type": "reference", "id": 73, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] }, { "id": 361, "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" }, { "type": "stringLiteral", "value": "not.eq" }, { "type": "stringLiteral", "value": "not.neq" }, { "type": "stringLiteral", "value": "not.gt" }, { "type": "stringLiteral", "value": "not.gte" }, { "type": "stringLiteral", "value": "not.lt" }, { "type": "stringLiteral", "value": "not.lte" }, { "type": "stringLiteral", "value": "not.like" }, { "type": "stringLiteral", "value": "not.ilike" }, { "type": "stringLiteral", "value": "not.is" }, { "type": "stringLiteral", "value": "not.in" }, { "type": "stringLiteral", "value": "not.cs" }, { "type": "stringLiteral", "value": "not.cd" }, { "type": "stringLiteral", "value": "not.sl" }, { "type": "stringLiteral", "value": "not.sr" }, { "type": "stringLiteral", "value": "not.nxl" }, { "type": "stringLiteral", "value": "not.nxr" }, { "type": "stringLiteral", "value": "not.adj" }, { "type": "stringLiteral", "value": "not.ov" }, { "type": "stringLiteral", "value": "not.fts" }, { "type": "stringLiteral", "value": "not.plfts" }, { "type": "stringLiteral", "value": "not.phfts" }, { "type": "stringLiteral", "value": "not.wfts" } ] } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [150] }, { "title": "Type aliases", "kind": 4194304, "children": [361] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 362, "name": "\"lib/PostgrestQueryBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/lib/PostgrestQueryBuilder.ts", "children": [ { "id": 363, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 364, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 365, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 366, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 367, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "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": 375, "name": "fetch", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 10, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "id": 375, "name": "fetch" } ] } }, { "id": 370, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 8, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 371, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 372, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 373, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 374, "name": "schema", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 9, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 376, "name": "shouldThrowOnError", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 11, "character": 24 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [375, 370, 374, 376] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 6, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 363, "name": "PostgrestQueryBuilder" }, "overwrites": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 4, "character": 75 } ], "overwrites": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } }, { "id": 432, "name": "allowEmpty", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 40, "name": "PostgrestBuilder.allowEmpty" } }, { "id": 428, "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": 431, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 59, "character": 17 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" }, "inheritedFrom": { "type": "reference", "id": 39, "name": "PostgrestBuilder.fetch" } }, { "id": 423, "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": 424, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 425, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 426, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 421, "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": 427, "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": 429, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 430, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 58, "character": 18 } ], "type": { "type": "reference", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.signal" } }, { "id": 422, "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": 415, "name": "delete", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 416, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs a DELETE on the table." }, "parameters": [ { "id": 417, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 418, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 420, "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": 214, "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": 419, "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": 213, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [420, 419] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 212, "character": 9 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 212, "character": 8 } ] }, { "id": 384, "name": "insert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 385, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an INSERT into the table." }, "parameters": [ { "id": 386, "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": 387, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 388, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 390, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 78, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] } }, { "id": 389, "name": "returning", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 77, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [390, 389] } ] } } ] } } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } }, { "id": 391, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `upsert()` instead.\n" } ] }, "parameters": [ { "id": 392, "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": 393, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 394, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 398, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 90, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] } }, { "id": 396, "name": "onConflict", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 88, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 397, "name": "returning", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 89, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] } }, { "id": 395, "name": "upsert", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 87, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [398, 396, 397, 395] } ] } } ] } } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 74, "character": 8 }, { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 84, "character": 8 }, { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 93, "character": 8 } ] }, { "id": 377, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 378, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 379, "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": 380, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 381, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 383, "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": 36, "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": 382, "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": 35, "character": 10 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [383, 382] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 33, "character": 18 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 32, "character": 8 } ] }, { "id": 436, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 437, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 438, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 439, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 440, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 441, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 442, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 443, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 66, "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": 93, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 444, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 445, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 446, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 447, "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": 96, "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": 47, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 91, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 47, "name": "PostgrestBuilder.then" } }, { "id": 433, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 434, "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" }, "parameters": [ { "id": 435, "name": "throwOnError", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 83, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } }, { "id": 408, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 409, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPDATE on the table." }, "parameters": [ { "id": 410, "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": 411, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 412, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 414, "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": 187, "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": 413, "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": 186, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [414, 413] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 184, "character": 23 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 183, "character": 8 } ] }, { "id": 399, "name": "upsert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 400, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPSERT into the table." }, "parameters": [ { "id": 401, "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": 402, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 403, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 406, "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": 147, "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": 407, "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": 148, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 404, "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": 145, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 405, "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": 146, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [406, 407, 404, 405] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 143, "character": 38 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 142, "character": 8 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [365] }, { "title": "Properties", "kind": 1024, "children": [432, 428, 431, 423, 421, 427, 429, 430, 422] }, { "title": "Methods", "kind": 2048, "children": [415, 384, 377, 436, 433, 408, 399] } ], "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": 66, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [363] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 448, "name": "\"lib/PostgrestRpcBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/lib/PostgrestRpcBuilder.ts", "children": [ { "id": 449, "name": "PostgrestRpcBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 450, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 451, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 452, "name": "new PostgrestRpcBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 453, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "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": 461, "name": "fetch", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 10, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "id": 375, "name": "fetch" } ] } }, { "id": 456, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 8, "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 }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 9, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 462, "name": "shouldThrowOnError", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 11, "character": 24 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [461, 456, 460, 462] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 6, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 449, "name": "PostgrestRpcBuilder" }, "overwrites": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 4, "character": 73 } ], "overwrites": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } }, { "id": 481, "name": "allowEmpty", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 40, "name": "PostgrestBuilder.allowEmpty" } }, { "id": 477, "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": 480, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 59, "character": 17 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" }, "inheritedFrom": { "type": "reference", "id": 39, "name": "PostgrestBuilder.fetch" } }, { "id": 472, "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": 473, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 474, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 475, "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": 470, "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": 476, "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": 478, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 479, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 58, "character": 18 } ], "type": { "type": "reference", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.signal" } }, { "id": 471, "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": 463, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 464, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a function call." }, "parameters": [ { "id": 465, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "object" } ] } }, { "id": 466, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 467, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 469, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 32, "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": 468, "name": "head", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 31, "character": 10 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [469, 468] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 29, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 150, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 28, "character": 5 } ] }, { "id": 485, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 486, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 487, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 488, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 489, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 490, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 491, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 492, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 66, "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": 93, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 493, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 494, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 495, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 496, "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": 96, "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": 47, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 91, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 47, "name": "PostgrestBuilder.then" } }, { "id": 482, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 483, "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" }, "parameters": [ { "id": 484, "name": "throwOnError", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 83, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [451] }, { "title": "Properties", "kind": 1024, "children": [481, 477, 480, 472, 470, 476, 478, 479, 471] }, { "title": "Methods", "kind": 2048, "children": [463, 485, 482] } ], "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": 66, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [449] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 72, "name": "\"lib/PostgrestTransformBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/lib/PostgrestTransformBuilder.ts", "children": [ { "id": 73, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "comment": { "shortText": "Post-filters (transforms)" }, "typeParameter": [ { "id": 74, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 131, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 132, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 133, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder", "dereferenced": { "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": 41, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 42, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 43, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder", "dereferenced": "[Circular ~.children.5.children.0.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", "id": 27, "name": "PostgrestBuilder" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 31 } ] }, { "id": 40, "name": "allowEmpty", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "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": 39, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 59, "character": 17 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" } }, { "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 }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 38, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 58, "character": 18 } ], "type": { "type": "reference", "name": "AbortSignal" } }, { "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": 47, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 48, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 49, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 50, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 51, "name": "onfulfilled", "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": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 66, "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": 93, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 55, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 57, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 58, "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": 96, "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": 91, "character": 6 } ] }, { "id": 44, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 45, "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" }, "parameters": [ { "id": 46, "name": "throwOnError", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 83, "character": 14 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [41] }, { "title": "Properties", "kind": 1024, "children": [40, 36, 39, 31, 29, 35, 37, 38, 30] }, { "title": "Methods", "kind": 2048, "children": [47, 44] } ], "sources": [ { "fileName": "lib/types.ts", "line": 51, "character": 38 } ], "extendedBy": [ { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder" }, { "type": "reference", "id": 363, "name": "PostgrestQueryBuilder" }, { "type": "reference", "id": 449, "name": "PostgrestRpcBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } } } ], "type": { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 31 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.__constructor" } }, { "id": 130, "name": "allowEmpty", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 40, "name": "PostgrestBuilder.allowEmpty" } }, { "id": 126, "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": 129, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 59, "character": 17 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" }, "inheritedFrom": { "type": "reference", "id": 39, "name": "PostgrestBuilder.fetch" } }, { "id": 121, "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": 122, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 123, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 124, "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": 119, "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": 125, "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": 127, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 128, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 58, "character": 18 } ], "type": { "type": "reference", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.signal" } }, { "id": 120, "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": 99, "name": "abortSignal", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 100, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Sets the AbortSignal for the fetch request." }, "parameters": [ { "id": 101, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "AbortSignal" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 91, "character": 13 } ] }, { "id": 106, "name": "csv", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 107, "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": 68, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 119, "character": 5 } ] }, { "id": 110, "name": "explain", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 111, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Obtains the EXPLAIN plan for this request." }, "parameters": [ { "id": 112, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 114, "name": "analyze", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, the query will be executed and the actual run time will be displayed." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 142, "character": 11 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 117, "name": "buffers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, include information on buffer usage." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 145, "character": 11 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 116, "name": "settings", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, include information on configuration parameters that affect query planning." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 144, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 115, "name": "verbose", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, the query identifier will be displayed and the result will include the output columns of the query." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 143, "character": 11 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 118, "name": "wal", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, include information on WAL record generation\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 146, "character": 7 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [114, 117, 116, 115, 118] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 141, "character": 10 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 141, "character": 9 } ] }, { "id": 108, "name": "geojson", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 109, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set the response type to GeoJSON." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 68, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 127, "character": 9 } ] }, { "id": 86, "name": "limit", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 87, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result with the specified `count`." }, "parameters": [ { "id": 88, "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": 89, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 90, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 91, "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": [91] } ], "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": 104, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 105, "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": 70, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestMaybeSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 110, "character": 13 } ] }, { "id": 78, "name": "order", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 79, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Orders the result with the specified `column`." }, "parameters": [ { "id": 80, "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": 81, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 82, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 83, "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": 85, "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": 84, "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": [83, 85, 84] } ], "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": 92, "name": "range", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 93, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result to rows within the specified range, inclusive." }, "parameters": [ { "id": 94, "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": 95, "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": 96, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 97, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 98, "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": [98] } ], "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": 75, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 76, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 77, "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": 102, "name": "single", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 103, "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": 68, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 100, "character": 8 } ] }, { "id": 137, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 138, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 139, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 140, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 141, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 143, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 144, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 66, "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": 93, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 145, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 147, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 148, "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": 96, "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": 47, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 91, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 47, "name": "PostgrestBuilder.then" } }, { "id": 134, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 135, "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" }, "parameters": [ { "id": 136, "name": "throwOnError", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 83, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 44, "name": "PostgrestBuilder.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [131] }, { "title": "Properties", "kind": 1024, "children": [130, 126, 129, 121, 119, 125, 127, 128, 120] }, { "title": "Methods", "kind": 2048, "children": [99, 106, 110, 108, 86, 104, 78, 92, 75, 102, 137, 134] } ], "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": 150, "name": "PostgrestFilterBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [73] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 499, "name": "\"lib/constants\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/lib/constants.ts", "children": [ { "id": 500, "name": "DEFAULT_HEADERS", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true, "isConst": true }, "children": [ { "id": 501, "name": "X-Client-Info", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 2, "character": 48 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "`postgrest-js/${version}`" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [501] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 2, "character": 28 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [500] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 1, "character": 0 } ] }, { "id": 1, "name": "\"lib/types\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/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": 41, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 42, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 43, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder", "dereferenced": { "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": "[Circular ~.children.7.children.0.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [41] }, { "title": "Properties", "kind": 1024, "children": [40, 36, 39, 31, 29, 35, 37, 38, 30] }, { "title": "Methods", "kind": 2048, "children": [47, 44] } ], "sources": [ { "fileName": "lib/types.ts", "line": 51, "character": 38 } ], "extendedBy": [ { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder" }, { "type": "reference", "id": 363, "name": "PostgrestQueryBuilder" }, { "type": "reference", "id": 449, "name": "PostgrestRpcBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } } } ], "type": { "type": "reference", "id": 27, "name": "PostgrestBuilder" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 31 } ] }, { "id": 40, "name": "allowEmpty", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 60, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "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": 39, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 59, "character": 17 } ], "type": { "type": "reference", "id": 59, "name": "Fetch" } }, { "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 }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 38, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 58, "character": 18 } ], "type": { "type": "reference", "name": "AbortSignal" } }, { "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": 47, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 48, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 49, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 50, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 51, "name": "onfulfilled", "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": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 66, "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": 93, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 55, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 57, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 58, "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": 96, "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": 91, "character": 6 } ] }, { "id": 44, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 45, "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" }, "parameters": [ { "id": 46, "name": "throwOnError", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 83, "character": 14 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [41] }, { "title": "Properties", "kind": 1024, "children": [40, 36, 39, 31, 29, 35, 37, 38, 30] }, { "title": "Methods", "kind": 2048, "children": [47, 44] } ], "sources": [ { "fileName": "lib/types.ts", "line": 51, "character": 38 } ], "extendedBy": [ { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder" }, { "type": "reference", "id": 363, "name": "PostgrestQueryBuilder" }, { "type": "reference", "id": 449, "name": "PostgrestRpcBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 66, "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": 60, "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": 59, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 375, "name": "fetch" } } }, { "id": 60, "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": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 65, "name": "code", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 12, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 63, "name": "details", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 10, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 64, "name": "hint", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 11, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 62, "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": [65, 63, 64, 62] } ], "sources": [ { "fileName": "lib/types.ts", "line": 8, "character": 28 } ] } } }, { "id": 70, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 71, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "sources": [ { "fileName": "lib/types.ts", "line": 49, "character": 40 } ], "type": { "type": "reference", "id": 68, "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "T" }, { "type": "intrinsic", "name": "null" } ] } ], "name": "PostgrestSingleResponse" } }, { "id": 66, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 67, "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": 68, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 69, "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": [59, 60, 70, 66, 68] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 0 } ] }, { "id": 497, "name": "\"lib/version\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/postgrest-js/src/lib/version.ts", "children": [ { "id": 498, "name": "version", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isConst": true }, "sources": [ { "fileName": "lib/version.ts", "line": 2, "character": 20 } ], "type": { "type": "stringLiteral", "value": "0.0.0-automated" }, "defaultValue": "\"0.0.0-automated\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [498] } ], "sources": [ { "fileName": "lib/version.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [502, 540, 149, 362, 448, 72, 499, 1, 497] } ] }, { "id": 0, "name": "@supabase/realtime-js", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 227, "name": "\"RealtimeClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/RealtimeClient.ts", "children": [ { "id": 228, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 260, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Socket." }, "signatures": [ { "id": 261, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 262, "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": 263, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 340, "name": "Options", "dereferenced": { "id": 340, "name": "Options", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 348, "name": "decode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 23, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 347, "name": "encode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 22, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 350, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 25, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 352, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 353, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 344, "name": "heartbeatIntervalMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 19, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 346, "name": "logger", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 21, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 345, "name": "longpollerTimeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 20, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 354, "name": "params", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 26, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 356, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 357, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 349, "name": "reconnectAfterMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 24, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 343, "name": "timeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 18, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 342, "name": "transport", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 17, "character": 11 } ], "type": { "type": "reference", "name": "WebSocket" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [348, 347, 350, 344, 346, 345, 354, 349, 343, 342] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 21 } ] } } } } } ], "type": { "type": "reference", "id": 228, "name": "RealtimeClient" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 73, "character": 3 } ] }, { "id": 229, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 43, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 230, "name": "channels", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 44, "character": 10 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } }, "defaultValue": "[]" }, { "id": 252, "name": "conn", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 60, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "WebSocket" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 250, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 58, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 249, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 57, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 231, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 45, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"\"" }, { "id": 232, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 46, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 234, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 235, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 242, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 50, "character": 21 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 244, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 52, "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": 248, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 56, "character": 8 } ], "type": { "type": "reference", "name": "Function" }, "defaultValue": "noop" }, { "id": 243, "name": "longpollerTimeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 51, "character": 19 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "20000" }, { "id": 236, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 47, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 238, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 239, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 245, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 53, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 251, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 59, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 247, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 55, "character": 16 } ], "type": { "type": "reference", "id": 35, "name": "Timer" } }, { "id": 246, "name": "ref", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 54, "character": 5 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 253, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 61, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "Function" } }, "defaultValue": "[]" }, { "id": 254, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 62, "character": 12 } ], "type": { "type": "reference", "id": 49, "name": "Serializer" }, "defaultValue": "new Serializer()" }, { "id": 240, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 48, "character": 9 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 241, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 49, "character": 11 } ], "type": { "type": "intrinsic", "name": "any" }, "defaultValue": "w3cwebsocket" }, { "id": 329, "name": "_appendParams", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 330, "name": "_appendParams", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 331, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 332, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 334, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 335, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 405, "character": 11 } ] } } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 403, "character": 23 } ] }, { "id": 336, "name": "_flushSendBuffer", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 337, "name": "_flushSendBuffer", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 416, "character": 26 } ] }, { "id": 321, "name": "_onConnClose", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 322, "name": "_onConnClose", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 323, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 383, "character": 22 } ] }, { "id": 324, "name": "_onConnError", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 325, "name": "_onConnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 326, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "ErrorEvent" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 391, "character": 22 } ] }, { "id": 319, "name": "_onConnOpen", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 320, "name": "_onConnOpen", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 371, "character": 21 } ] }, { "id": 338, "name": "_sendHeartbeat", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 339, "name": "_sendHeartbeat", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 423, "character": 24 } ] }, { "id": 327, "name": "_triggerChanError", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 328, "name": "_triggerChanError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 397, "character": 27 } ] }, { "id": 297, "name": "channel", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 298, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 299, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 300, "name": "chanParams", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 364, "name": "ChannelParams", "dereferenced": { "id": 364, "name": "ChannelParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 18 } ], "type": { "type": "reflection", "declaration": { "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 367, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 368, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "children": [ { "id": 366, "name": "selfBroadcast", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 36, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [366] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 20 } ] } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 264, "character": 9 } ] }, { "id": 264, "name": "connect", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 265, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 125, "character": 9 } ] }, { "id": 290, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 291, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "id": 24, "name": "CONNECTION_STATE" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 233, "character": 17 } ] }, { "id": 266, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 267, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 268, "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": 269, "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": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 272, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 40 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 271, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [272, 271] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 148, "character": 12 } ] }, { "id": 309, "name": "endPointURL", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 310, "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": 320, "character": 13 } ] }, { "id": 292, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 293, "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": 249, "character": 13 } ] }, { "id": 316, "name": "leaveOpenTopic", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 317, "name": "leaveOpenTopic", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Unsubscribe from channels with the specified topic." }, "parameters": [ { "id": 318, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 361, "character": 16 } ] }, { "id": 273, "name": "log", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 274, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overriden.\n" }, "parameters": [ { "id": 275, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 276, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 277, "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": 178, "character": 5 } ] }, { "id": 311, "name": "makeRef", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 312, "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": 330, "character": 9 } ] }, { "id": 281, "name": "onClose", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 282, "name": "onClose", "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(() => console.log(\"Socket closed.\"))\n" } ] }, "parameters": [ { "id": 283, "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": 202, "character": 9 } ] }, { "id": 304, "name": "onConnMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 305, "name": "onConnMessage", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 306, "name": "rawMessage", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 307, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 308, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 34 } ], "type": { "type": "intrinsic", "name": "any" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [308] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 27 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 15 } ] }, { "id": 284, "name": "onError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 285, "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": 286, "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": 214, "character": 9 } ] }, { "id": 287, "name": "onMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 288, "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": 289, "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": 226, "character": 11 } ] }, { "id": 278, "name": "onOpen", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 279, "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": 280, "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": 190, "character": 8 } ] }, { "id": 301, "name": "push", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 302, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 303, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 358, "name": "Message", "dereferenced": { "id": 358, "name": "Message", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 361, "name": "event", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 30, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 362, "name": "payload", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 31, "character": 9 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 363, "name": "ref", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 32, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 360, "name": "topic", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 29, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [361, 362, 363, 360] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 14 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 275, "character": 6 } ] }, { "id": 294, "name": "remove", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 295, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Removes a subscription from the socket." }, "parameters": [ { "id": 296, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "An open subscription.\n" }, "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription", "dereferenced": { "id": 140, "name": "RealtimeSubscription", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 148, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 155, "name": "new RealtimeSubscription", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 156, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 157, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 159, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 160, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 18 } ] } }, "defaultValue": "{}" }, { "id": 161, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 228, "name": "RealtimeClient", "dereferenced": { "id": 228, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": "[Circular ~.children.0.children.0.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [260] }, { "title": "Properties", "kind": 1024, "children": [ 229, 230, 252, 250, 249, 231, 232, 242, 244, 248, 243, 236, 245, 251, 247, 246, 253, 254, 240, 241 ] }, { "title": "Methods", "kind": 2048, "children": [ 329, 336, 321, 324, 319, 338, 327, 297, 264, 290, 266, 309, 292, 316, 273, 311, 281, 304, 284, 287, 278, 301, 294, 313 ] }, { "title": "Object literals", "kind": 2097152, "children": [255] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 42, "character": 35 } ] } } } ], "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 13, "character": 25 } ] }, { "id": 141, "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": 145, "name": "joinPush", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 11, "character": 10 } ], "type": { "type": "reference", "id": 74, "name": "Push" } }, { "id": 144, "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": 150, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true, "isExported": true, "isConstructorProperty": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 17 } ], "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 152, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 153, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 18 } ] } } }, { "id": 147, "name": "pushBuffer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 13, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 74, "name": "Push" } }, "defaultValue": "[]" }, { "id": 146, "name": "rejoinTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 12, "character": 13 } ], "type": { "type": "reference", "id": 35, "name": "Timer" } }, { "id": 154, "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": 228, "name": "RealtimeClient" } }, { "id": 143, "name": "state", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 9, "character": 7 } ], "type": { "type": "reference", "id": 9, "name": "CHANNEL_STATES" }, "defaultValue": "CHANNEL_STATES.closed" }, { "id": 142, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 8, "character": 9 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 149, "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": 180, "name": "canPush", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 181, "name": "canPush", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 97, "character": 9 } ] }, { "id": 217, "name": "isClosed", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 218, "name": "isClosed", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 202, "character": 10 } ] }, { "id": 219, "name": "isErrored", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 220, "name": "isErrored", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 205, "character": 11 } ] }, { "id": 221, "name": "isJoined", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 222, "name": "isJoined", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 208, "character": 10 } ] }, { "id": 223, "name": "isJoining", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 224, "name": "isJoining", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 211, "character": 11 } ] }, { "id": 225, "name": "isLeaving", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 226, "name": "isLeaving", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 214, "character": 11 } ] }, { "id": 201, "name": "isMember", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 202, "name": "isMember", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 203, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 158, "character": 10 } ] }, { "id": 204, "name": "joinRef", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 205, "name": "joinRef", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 162, "character": 9 } ] }, { "id": 177, "name": "off", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 178, "name": "off", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 179, "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": 173, "name": "on", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 174, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 175, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 176, "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": 167, "name": "onClose", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 168, "name": "onClose", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 169, "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": 170, "name": "onError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 171, "name": "onError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 172, "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": 196, "name": "onMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 197, "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": 198, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 199, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 200, "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": 154, "character": 11 } ] }, { "id": 182, "name": "push", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 183, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 184, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 15, "name": "CHANNEL_EVENTS", "dereferenced": { "id": 15, "name": "CHANNEL_EVENTS", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "children": [ { "id": 21, "name": "access_token", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 32, "character": 14 } ], "defaultValue": "\"access_token\"" }, { "id": 16, "name": "close", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 27, "character": 7 } ], "defaultValue": "\"phx_close\"" }, { "id": 17, "name": "error", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 28, "character": 7 } ], "defaultValue": "\"phx_error\"" }, { "id": 18, "name": "join", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 29, "character": 6 } ], "defaultValue": "\"phx_join\"" }, { "id": 20, "name": "leave", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 31, "character": 7 } ], "defaultValue": "\"phx_leave\"" }, { "id": 19, "name": "reply", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 30, "character": 7 } ], "defaultValue": "\"phx_reply\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [21, 16, 17, 18, 20, 19] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 26, "character": 26 } ] } } }, { "id": 185, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 186, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 101, "character": 6 } ] }, { "id": 206, "name": "rejoin", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 207, "name": "rejoin", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 208, "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": 166, "character": 8 } ] }, { "id": 162, "name": "rejoinUntilConnected", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 163, "name": "rejoinUntilConnected", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 64, "character": 22 } ] }, { "id": 214, "name": "replyEventName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 215, "name": "replyEventName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 216, "name": "ref", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 198, "character": 16 } ] }, { "id": 164, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 165, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 166, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 71, "character": 11 } ] }, { "id": 209, "name": "trigger", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 210, "name": "trigger", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 211, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 212, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 213, "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": 175, "character": 9 } ] }, { "id": 193, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 194, "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": 195, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 129, "character": 13 } ] }, { "id": 187, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 188, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 189, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 191, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 192, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 116, "character": 28 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 116, "character": 19 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [148] }, { "title": "Properties", "kind": 1024, "children": [141, 145, 144, 150, 147, 146, 154, 143, 142, 149] }, { "title": "Methods", "kind": 2048, "children": [ 180, 217, 219, 221, 223, 225, 201, 204, 177, 173, 167, 170, 196, 182, 206, 162, 214, 164, 209, 193, 187 ] } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 6, "character": 41 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 258, "character": 8 } ] }, { "id": 313, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 314, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 315, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 346, "character": 9 } ] }, { "id": 255, "name": "stateChangeCallbacks", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true }, "children": [ { "id": 257, "name": "close", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 70, "character": 9 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 258, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 71, "character": 9 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 259, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 72, "character": 11 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 256, "name": "open", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 69, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [257, 258, 259, 256] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 63, "character": 22 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [260] }, { "title": "Properties", "kind": 1024, "children": [ 229, 230, 252, 250, 249, 231, 232, 242, 244, 248, 243, 236, 245, 251, 247, 246, 253, 254, 240, 241 ] }, { "title": "Methods", "kind": 2048, "children": [ 329, 336, 321, 324, 319, 338, 327, 297, 264, 290, 266, 309, 292, 316, 273, 311, 281, 304, 284, 287, 278, 301, 294, 313 ] }, { "title": "Object literals", "kind": 2097152, "children": [255] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 42, "character": 35 } ] }, { "id": 364, "name": "ChannelParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 18 } ], "type": { "type": "reflection", "declaration": { "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 367, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 368, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "children": [ { "id": 366, "name": "selfBroadcast", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 36, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [366] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 20 } ] } } }, { "id": 358, "name": "Message", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 361, "name": "event", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 30, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 362, "name": "payload", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 31, "character": 9 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 363, "name": "ref", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 32, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 360, "name": "topic", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 29, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [361, 362, 363, 360] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 14 } ] } } }, { "id": 340, "name": "Options", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 348, "name": "decode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 23, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 347, "name": "encode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 22, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 350, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 25, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 352, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 353, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 344, "name": "heartbeatIntervalMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 19, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 346, "name": "logger", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 21, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 345, "name": "longpollerTimeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 20, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 354, "name": "params", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 26, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 356, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 357, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 349, "name": "reconnectAfterMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 24, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 343, "name": "timeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 18, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 342, "name": "transport", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 17, "character": 11 } ], "type": { "type": "reference", "name": "WebSocket" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [348, 347, 350, 344, 346, 345, 354, 349, 343, 342] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 21 } ] } } }, { "id": 369, "name": "noop", "kind": 64, "kindString": "Function", "flags": { "isConst": true }, "signatures": [ { "id": 370, "name": "noop", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 40, "character": 10 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [228] }, { "title": "Type aliases", "kind": 4194304, "children": [364, 358, 340] }, { "title": "Functions", "kind": 64, "children": [369] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 1, "character": 0 } ] }, { "id": 139, "name": "\"RealtimeSubscription\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/RealtimeSubscription.ts", "children": [ { "id": 140, "name": "RealtimeSubscription", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 148, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 155, "name": "new RealtimeSubscription", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 156, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 157, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 159, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 160, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 18 } ] } }, "defaultValue": "{}" }, { "id": 161, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 228, "name": "RealtimeClient", "dereferenced": { "id": 228, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 260, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Socket." }, "signatures": [ { "id": 261, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 262, "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": 263, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 340, "name": "Options", "dereferenced": { "id": 340, "name": "Options", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 348, "name": "decode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 23, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 347, "name": "encode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 22, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 350, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 25, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 352, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 353, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 344, "name": "heartbeatIntervalMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 19, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 346, "name": "logger", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 21, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 345, "name": "longpollerTimeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 20, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 354, "name": "params", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 26, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 356, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 357, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 349, "name": "reconnectAfterMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 24, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 343, "name": "timeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 18, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 342, "name": "transport", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 17, "character": 11 } ], "type": { "type": "reference", "name": "WebSocket" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 348, 347, 350, 344, 346, 345, 354, 349, 343, 342 ] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 21 } ] } } } } } ], "type": { "type": "reference", "id": 228, "name": "RealtimeClient" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 73, "character": 3 } ] }, { "id": 229, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 43, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 230, "name": "channels", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 44, "character": 10 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } }, "defaultValue": "[]" }, { "id": 252, "name": "conn", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 60, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "WebSocket" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 250, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 58, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 249, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 57, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 231, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 45, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"\"" }, { "id": 232, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 46, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 234, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 235, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 242, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 50, "character": 21 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 244, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 52, "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": 248, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 56, "character": 8 } ], "type": { "type": "reference", "name": "Function" }, "defaultValue": "noop" }, { "id": 243, "name": "longpollerTimeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 51, "character": 19 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "20000" }, { "id": 236, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 47, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 238, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 239, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 245, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 53, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 251, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 59, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 247, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 55, "character": 16 } ], "type": { "type": "reference", "id": 35, "name": "Timer" } }, { "id": 246, "name": "ref", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 54, "character": 5 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 253, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 61, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "Function" } }, "defaultValue": "[]" }, { "id": 254, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 62, "character": 12 } ], "type": { "type": "reference", "id": 49, "name": "Serializer" }, "defaultValue": "new Serializer()" }, { "id": 240, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 48, "character": 9 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 241, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 49, "character": 11 } ], "type": { "type": "intrinsic", "name": "any" }, "defaultValue": "w3cwebsocket" }, { "id": 329, "name": "_appendParams", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 330, "name": "_appendParams", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 331, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 332, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 334, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 335, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 405, "character": 11 } ] } } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 403, "character": 23 } ] }, { "id": 336, "name": "_flushSendBuffer", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 337, "name": "_flushSendBuffer", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 416, "character": 26 } ] }, { "id": 321, "name": "_onConnClose", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 322, "name": "_onConnClose", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 323, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 383, "character": 22 } ] }, { "id": 324, "name": "_onConnError", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 325, "name": "_onConnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 326, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "ErrorEvent" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 391, "character": 22 } ] }, { "id": 319, "name": "_onConnOpen", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 320, "name": "_onConnOpen", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 371, "character": 21 } ] }, { "id": 338, "name": "_sendHeartbeat", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 339, "name": "_sendHeartbeat", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 423, "character": 24 } ] }, { "id": 327, "name": "_triggerChanError", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 328, "name": "_triggerChanError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 397, "character": 27 } ] }, { "id": 297, "name": "channel", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 298, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 299, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 300, "name": "chanParams", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 364, "name": "ChannelParams", "dereferenced": { "id": 364, "name": "ChannelParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 18 } ], "type": { "type": "reflection", "declaration": { "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 367, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 368, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "children": [ { "id": 366, "name": "selfBroadcast", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 36, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [366] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 20 } ] } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 264, "character": 9 } ] }, { "id": 264, "name": "connect", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 265, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 125, "character": 9 } ] }, { "id": 290, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 291, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "id": 24, "name": "CONNECTION_STATE" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 233, "character": 17 } ] }, { "id": 266, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 267, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 268, "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": 269, "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": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 272, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 40 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 271, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [272, 271] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 148, "character": 12 } ] }, { "id": 309, "name": "endPointURL", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 310, "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": 320, "character": 13 } ] }, { "id": 292, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 293, "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": 249, "character": 13 } ] }, { "id": 316, "name": "leaveOpenTopic", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 317, "name": "leaveOpenTopic", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Unsubscribe from channels with the specified topic." }, "parameters": [ { "id": 318, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 361, "character": 16 } ] }, { "id": 273, "name": "log", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 274, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overriden.\n" }, "parameters": [ { "id": 275, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 276, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 277, "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": 178, "character": 5 } ] }, { "id": 311, "name": "makeRef", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 312, "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": 330, "character": 9 } ] }, { "id": 281, "name": "onClose", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 282, "name": "onClose", "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(() => console.log(\"Socket closed.\"))\n" } ] }, "parameters": [ { "id": 283, "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": 202, "character": 9 } ] }, { "id": 304, "name": "onConnMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 305, "name": "onConnMessage", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 306, "name": "rawMessage", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 307, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 308, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 34 } ], "type": { "type": "intrinsic", "name": "any" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [308] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 27 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 15 } ] }, { "id": 284, "name": "onError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 285, "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": 286, "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": 214, "character": 9 } ] }, { "id": 287, "name": "onMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 288, "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": 289, "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": 226, "character": 11 } ] }, { "id": 278, "name": "onOpen", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 279, "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": 280, "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": 190, "character": 8 } ] }, { "id": 301, "name": "push", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 302, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 303, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 358, "name": "Message", "dereferenced": { "id": 358, "name": "Message", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 361, "name": "event", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 30, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 362, "name": "payload", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 31, "character": 9 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 363, "name": "ref", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 32, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 360, "name": "topic", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 29, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [361, 362, 363, 360] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 14 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 275, "character": 6 } ] }, { "id": 294, "name": "remove", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 295, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Removes a subscription from the socket." }, "parameters": [ { "id": 296, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "An open subscription.\n" }, "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription", "dereferenced": { "id": 140, "name": "RealtimeSubscription", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": "[Circular ~.children.1.children.0.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [148] }, { "title": "Properties", "kind": 1024, "children": [ 141, 145, 144, 150, 147, 146, 154, 143, 142, 149 ] }, { "title": "Methods", "kind": 2048, "children": [ 180, 217, 219, 221, 223, 225, 201, 204, 177, 173, 167, 170, 196, 182, 206, 162, 214, 164, 209, 193, 187 ] } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 6, "character": 41 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 258, "character": 8 } ] }, { "id": 313, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 314, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 315, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 346, "character": 9 } ] }, { "id": 255, "name": "stateChangeCallbacks", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true }, "children": [ { "id": 257, "name": "close", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 70, "character": 9 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 258, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 71, "character": 9 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 259, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 72, "character": 11 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 256, "name": "open", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 69, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [257, 258, 259, 256] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 63, "character": 22 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [260] }, { "title": "Properties", "kind": 1024, "children": [ 229, 230, 252, 250, 249, 231, 232, 242, 244, 248, 243, 236, 245, 251, 247, 246, 253, 254, 240, 241 ] }, { "title": "Methods", "kind": 2048, "children": [ 329, 336, 321, 324, 319, 338, 327, 297, 264, 290, 266, 309, 292, 316, 273, 311, 281, 304, 284, 287, 278, 301, 294, 313 ] }, { "title": "Object literals", "kind": 2097152, "children": [255] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 42, "character": 35 } ] } } } ], "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 13, "character": 25 } ] }, { "id": 141, "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": 145, "name": "joinPush", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 11, "character": 10 } ], "type": { "type": "reference", "id": 74, "name": "Push" } }, { "id": 144, "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": 150, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true, "isExported": true, "isConstructorProperty": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 17 } ], "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 152, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 153, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 18 } ] } } }, { "id": 147, "name": "pushBuffer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 13, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 74, "name": "Push" } }, "defaultValue": "[]" }, { "id": 146, "name": "rejoinTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 12, "character": 13 } ], "type": { "type": "reference", "id": 35, "name": "Timer" } }, { "id": 154, "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": 228, "name": "RealtimeClient" } }, { "id": 143, "name": "state", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 9, "character": 7 } ], "type": { "type": "reference", "id": 9, "name": "CHANNEL_STATES" }, "defaultValue": "CHANNEL_STATES.closed" }, { "id": 142, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 8, "character": 9 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 149, "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": 180, "name": "canPush", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 181, "name": "canPush", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 97, "character": 9 } ] }, { "id": 217, "name": "isClosed", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 218, "name": "isClosed", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 202, "character": 10 } ] }, { "id": 219, "name": "isErrored", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 220, "name": "isErrored", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 205, "character": 11 } ] }, { "id": 221, "name": "isJoined", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 222, "name": "isJoined", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 208, "character": 10 } ] }, { "id": 223, "name": "isJoining", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 224, "name": "isJoining", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 211, "character": 11 } ] }, { "id": 225, "name": "isLeaving", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 226, "name": "isLeaving", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 214, "character": 11 } ] }, { "id": 201, "name": "isMember", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 202, "name": "isMember", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 203, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 158, "character": 10 } ] }, { "id": 204, "name": "joinRef", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 205, "name": "joinRef", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 162, "character": 9 } ] }, { "id": 177, "name": "off", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 178, "name": "off", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 179, "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": 173, "name": "on", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 174, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 175, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 176, "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": 167, "name": "onClose", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 168, "name": "onClose", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 169, "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": 170, "name": "onError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 171, "name": "onError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 172, "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": 196, "name": "onMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 197, "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": 198, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 199, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 200, "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": 154, "character": 11 } ] }, { "id": 182, "name": "push", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 183, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 184, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 15, "name": "CHANNEL_EVENTS", "dereferenced": { "id": 15, "name": "CHANNEL_EVENTS", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "children": [ { "id": 21, "name": "access_token", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 32, "character": 14 } ], "defaultValue": "\"access_token\"" }, { "id": 16, "name": "close", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 27, "character": 7 } ], "defaultValue": "\"phx_close\"" }, { "id": 17, "name": "error", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 28, "character": 7 } ], "defaultValue": "\"phx_error\"" }, { "id": 18, "name": "join", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 29, "character": 6 } ], "defaultValue": "\"phx_join\"" }, { "id": 20, "name": "leave", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 31, "character": 7 } ], "defaultValue": "\"phx_leave\"" }, { "id": 19, "name": "reply", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 30, "character": 7 } ], "defaultValue": "\"phx_reply\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [21, 16, 17, 18, 20, 19] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 26, "character": 26 } ] } } }, { "id": 185, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 186, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 101, "character": 6 } ] }, { "id": 206, "name": "rejoin", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 207, "name": "rejoin", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 208, "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": 166, "character": 8 } ] }, { "id": 162, "name": "rejoinUntilConnected", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 163, "name": "rejoinUntilConnected", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 64, "character": 22 } ] }, { "id": 214, "name": "replyEventName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 215, "name": "replyEventName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 216, "name": "ref", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 198, "character": 16 } ] }, { "id": 164, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 165, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 166, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 71, "character": 11 } ] }, { "id": 209, "name": "trigger", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 210, "name": "trigger", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 211, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 212, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 213, "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": 175, "character": 9 } ] }, { "id": 193, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 194, "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": 195, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 129, "character": 13 } ] }, { "id": 187, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 188, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 189, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 191, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 192, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 116, "character": 28 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 116, "character": 19 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [148] }, { "title": "Properties", "kind": 1024, "children": [141, 145, 144, 150, 147, 146, 154, 143, 142, 149] }, { "title": "Methods", "kind": 2048, "children": [ 180, 217, 219, 221, 223, 225, 201, 204, 177, 173, 167, 170, 196, 182, 206, 162, 214, 164, 209, 193, 187 ] } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 6, "character": 41 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [140] } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 1, "character": 0 } ] }, { "id": 445, "name": "\"index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/index.ts", "sources": [ { "fileName": "index.ts", "line": 1, "character": 0 } ] }, { "id": 3, "name": "\"lib/constants\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/lib/constants.ts", "children": [ { "id": 15, "name": "CHANNEL_EVENTS", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "children": [ { "id": 21, "name": "access_token", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 32, "character": 14 } ], "defaultValue": "\"access_token\"" }, { "id": 16, "name": "close", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 27, "character": 7 } ], "defaultValue": "\"phx_close\"" }, { "id": 17, "name": "error", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 28, "character": 7 } ], "defaultValue": "\"phx_error\"" }, { "id": 18, "name": "join", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 29, "character": 6 } ], "defaultValue": "\"phx_join\"" }, { "id": 20, "name": "leave", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 31, "character": 7 } ], "defaultValue": "\"phx_leave\"" }, { "id": 19, "name": "reply", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 30, "character": 7 } ], "defaultValue": "\"phx_reply\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [21, 16, 17, 18, 20, 19] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 26, "character": 26 } ] }, { "id": 9, "name": "CHANNEL_STATES", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "children": [ { "id": 10, "name": "closed", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 19, "character": 8 } ], "defaultValue": "\"closed\"" }, { "id": 11, "name": "errored", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 20, "character": 9 } ], "defaultValue": "\"errored\"" }, { "id": 12, "name": "joined", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 21, "character": 8 } ], "defaultValue": "\"joined\"" }, { "id": 13, "name": "joining", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 22, "character": 9 } ], "defaultValue": "\"joining\"" }, { "id": 14, "name": "leaving", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 23, "character": 9 } ], "defaultValue": "\"leaving\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [10, 11, 12, 13, 14] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 18, "character": 26 } ] }, { "id": 24, "name": "CONNECTION_STATE", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "children": [ { "id": 28, "name": "Closed", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 43, "character": 8 } ], "defaultValue": "\"closed\"" }, { "id": 27, "name": "Closing", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 42, "character": 9 } ], "defaultValue": "\"closing\"" }, { "id": 25, "name": "Connecting", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 40, "character": 12 } ], "defaultValue": "\"connecting\"" }, { "id": 26, "name": "Open", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 41, "character": 6 } ], "defaultValue": "\"open\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [28, 27, 25, 26] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 39, "character": 28 } ] }, { "id": 4, "name": "SOCKET_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": "3" }, { "id": 7, "name": "closing", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 14, "character": 9 } ], "defaultValue": "2" }, { "id": 5, "name": "connecting", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 12, "character": 12 } ], "defaultValue": "0" }, { "id": 6, "name": "open", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 13, "character": 6 } ], "defaultValue": "1" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [8, 7, 5, 6] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 11, "character": 25 } ] }, { "id": 22, "name": "TRANSPORTS", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "children": [ { "id": 23, "name": "websocket", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 36, "character": 11 } ], "defaultValue": "\"websocket\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [23] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 35, "character": 22 } ] }, { "id": 32, "name": "DEFAULT_TIMEOUT", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isConst": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 7, "character": 28 } ], "type": { "type": "unknown", "name": "10000" }, "defaultValue": "10000" }, { "id": 31, "name": "VSN", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isConst": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 5, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"1.0.0\"" }, { "id": 33, "name": "WS_CLOSE_NORMAL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isConst": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 9, "character": 28 } ], "type": { "type": "unknown", "name": "1000" }, "defaultValue": "1000" }, { "id": 29, "name": "DEFAULT_HEADERS", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true, "isConst": true }, "children": [ { "id": 30, "name": "X-Client-Info", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 3, "character": 48 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "`realtime-js/${version}`" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [30] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 3, "character": 28 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Enumerations", "kind": 4, "children": [15, 9, 24, 4, 22] }, { "title": "Variables", "kind": 32, "children": [32, 31, 33] }, { "title": "Object literals", "kind": 2097152, "children": [29] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 1, "character": 0 } ] }, { "id": 73, "name": "\"lib/push\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/lib/push.ts", "children": [ { "id": 74, "name": "Push", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 87, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Push" }, "signatures": [ { "id": 95, "name": "new Push", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Push" }, "parameters": [ { "id": 96, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "The Channel" }, "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription", "dereferenced": { "id": 140, "name": "RealtimeSubscription", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 148, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 155, "name": "new RealtimeSubscription", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 156, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 157, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 159, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 160, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 18 } ] } }, "defaultValue": "{}" }, { "id": 161, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 228, "name": "RealtimeClient", "dereferenced": { "id": 228, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 260, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Socket." }, "signatures": [ { "id": 261, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 262, "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": 263, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 340, "name": "Options", "dereferenced": { "id": 340, "name": "Options", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 348, "name": "decode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 23, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 347, "name": "encode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 22, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 350, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 25, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 352, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 353, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 344, "name": "heartbeatIntervalMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 19, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 346, "name": "logger", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 21, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 345, "name": "longpollerTimeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 20, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 354, "name": "params", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 26, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 356, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 357, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 349, "name": "reconnectAfterMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 24, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 343, "name": "timeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 18, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 342, "name": "transport", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 17, "character": 11 } ], "type": { "type": "reference", "name": "WebSocket" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 348, 347, 350, 344, 346, 345, 354, 349, 343, 342 ] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 16, "character": 21 } ] } } } } } ], "type": { "type": "reference", "id": 228, "name": "RealtimeClient" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 73, "character": 3 } ] }, { "id": 229, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 43, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 230, "name": "channels", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 44, "character": 10 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } }, "defaultValue": "[]" }, { "id": 252, "name": "conn", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 60, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "WebSocket" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 250, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 58, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 249, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 57, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 231, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 45, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"\"" }, { "id": 232, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 46, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 234, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 235, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 242, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 50, "character": 21 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 244, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 52, "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": 248, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 56, "character": 8 } ], "type": { "type": "reference", "name": "Function" }, "defaultValue": "noop" }, { "id": 243, "name": "longpollerTimeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 51, "character": 19 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "20000" }, { "id": 236, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 47, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 238, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 239, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 245, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 53, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 251, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 59, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 247, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 55, "character": 16 } ], "type": { "type": "reference", "id": 35, "name": "Timer" } }, { "id": 246, "name": "ref", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 54, "character": 5 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 253, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 61, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "Function" } }, "defaultValue": "[]" }, { "id": 254, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 62, "character": 12 } ], "type": { "type": "reference", "id": 49, "name": "Serializer" }, "defaultValue": "new Serializer()" }, { "id": 240, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 48, "character": 9 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 241, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 49, "character": 11 } ], "type": { "type": "intrinsic", "name": "any" }, "defaultValue": "w3cwebsocket" }, { "id": 329, "name": "_appendParams", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 330, "name": "_appendParams", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 331, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 332, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 334, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 335, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 405, "character": 11 } ] } } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 403, "character": 23 } ] }, { "id": 336, "name": "_flushSendBuffer", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 337, "name": "_flushSendBuffer", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 416, "character": 26 } ] }, { "id": 321, "name": "_onConnClose", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 322, "name": "_onConnClose", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 323, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 383, "character": 22 } ] }, { "id": 324, "name": "_onConnError", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 325, "name": "_onConnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 326, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "ErrorEvent" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 391, "character": 22 } ] }, { "id": 319, "name": "_onConnOpen", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 320, "name": "_onConnOpen", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 371, "character": 21 } ] }, { "id": 338, "name": "_sendHeartbeat", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 339, "name": "_sendHeartbeat", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 423, "character": 24 } ] }, { "id": 327, "name": "_triggerChanError", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 328, "name": "_triggerChanError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 397, "character": 27 } ] }, { "id": 297, "name": "channel", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 298, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 299, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 300, "name": "chanParams", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 364, "name": "ChannelParams", "dereferenced": { "id": 364, "name": "ChannelParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 18 } ], "type": { "type": "reflection", "declaration": { "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 367, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 368, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "children": [ { "id": 366, "name": "selfBroadcast", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 36, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [366] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 35, "character": 20 } ] } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 264, "character": 9 } ] }, { "id": 264, "name": "connect", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 265, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 125, "character": 9 } ] }, { "id": 290, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 291, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "id": 24, "name": "CONNECTION_STATE" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 233, "character": 17 } ] }, { "id": 266, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 267, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 268, "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": 269, "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": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 272, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 40 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 271, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [272, 271] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 151, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 148, "character": 12 } ] }, { "id": 309, "name": "endPointURL", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 310, "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": 320, "character": 13 } ] }, { "id": 292, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 293, "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": 249, "character": 13 } ] }, { "id": 316, "name": "leaveOpenTopic", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 317, "name": "leaveOpenTopic", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Unsubscribe from channels with the specified topic." }, "parameters": [ { "id": 318, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 361, "character": 16 } ] }, { "id": 273, "name": "log", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 274, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overriden.\n" }, "parameters": [ { "id": 275, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 276, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 277, "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": 178, "character": 5 } ] }, { "id": 311, "name": "makeRef", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 312, "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": 330, "character": 9 } ] }, { "id": 281, "name": "onClose", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 282, "name": "onClose", "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(() => console.log(\"Socket closed.\"))\n" } ] }, "parameters": [ { "id": 283, "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": 202, "character": 9 } ] }, { "id": 304, "name": "onConnMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 305, "name": "onConnMessage", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 306, "name": "rawMessage", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 307, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 308, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 34 } ], "type": { "type": "intrinsic", "name": "any" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [308] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 27 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 290, "character": 15 } ] }, { "id": 284, "name": "onError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 285, "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": 286, "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": 214, "character": 9 } ] }, { "id": 287, "name": "onMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 288, "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": 289, "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": 226, "character": 11 } ] }, { "id": 278, "name": "onOpen", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 279, "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": 280, "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": 190, "character": 8 } ] }, { "id": 301, "name": "push", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 302, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 303, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 358, "name": "Message", "dereferenced": { "id": 358, "name": "Message", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 361, "name": "event", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 30, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 362, "name": "payload", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 31, "character": 9 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 363, "name": "ref", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 32, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 360, "name": "topic", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "RealtimeClient.ts", "line": 29, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 361, 362, 363, 360 ] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 28, "character": 14 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 275, "character": 6 } ] }, { "id": 294, "name": "remove", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 295, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Removes a subscription from the socket." }, "parameters": [ { "id": 296, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "An open subscription.\n" }, "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription", "dereferenced": "[Circular ~.children.4.children.0.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 258, "character": 8 } ] }, { "id": 313, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 314, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 315, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 346, "character": 9 } ] }, { "id": 255, "name": "stateChangeCallbacks", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true }, "children": [ { "id": 257, "name": "close", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 70, "character": 9 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 258, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 71, "character": 9 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 259, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 72, "character": 11 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" }, { "id": 256, "name": "open", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 69, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "never" } }, "defaultValue": "[]" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [257, 258, 259, 256] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 63, "character": 22 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [260] }, { "title": "Properties", "kind": 1024, "children": [ 229, 230, 252, 250, 249, 231, 232, 242, 244, 248, 243, 236, 245, 251, 247, 246, 253, 254, 240, 241 ] }, { "title": "Methods", "kind": 2048, "children": [ 329, 336, 321, 324, 319, 338, 327, 297, 264, 290, 266, 309, 292, 316, 273, 311, 281, 304, 284, 287, 278, 301, 294, 313 ] }, { "title": "Object literals", "kind": 2097152, "children": [255] } ], "sources": [ { "fileName": "RealtimeClient.ts", "line": 42, "character": 35 } ] } } } ], "type": { "type": "reference", "id": 140, "name": "RealtimeSubscription" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 13, "character": 25 } ] }, { "id": 141, "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": 145, "name": "joinPush", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 11, "character": 10 } ], "type": { "type": "reference", "id": 74, "name": "Push" } }, { "id": 144, "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": 150, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true, "isExported": true, "isConstructorProperty": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 17 } ], "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 152, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 153, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 17, "character": 18 } ] } } }, { "id": 147, "name": "pushBuffer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 13, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 74, "name": "Push" } }, "defaultValue": "[]" }, { "id": 146, "name": "rejoinTimer", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 12, "character": 13 } ], "type": { "type": "reference", "id": 35, "name": "Timer" } }, { "id": 154, "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": 228, "name": "RealtimeClient" } }, { "id": 143, "name": "state", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 9, "character": 7 } ], "type": { "type": "reference", "id": 9, "name": "CHANNEL_STATES" }, "defaultValue": "CHANNEL_STATES.closed" }, { "id": 142, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 8, "character": 9 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 149, "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": 180, "name": "canPush", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 181, "name": "canPush", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 97, "character": 9 } ] }, { "id": 217, "name": "isClosed", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 218, "name": "isClosed", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 202, "character": 10 } ] }, { "id": 219, "name": "isErrored", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 220, "name": "isErrored", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 205, "character": 11 } ] }, { "id": 221, "name": "isJoined", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 222, "name": "isJoined", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 208, "character": 10 } ] }, { "id": 223, "name": "isJoining", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 224, "name": "isJoining", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 211, "character": 11 } ] }, { "id": 225, "name": "isLeaving", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 226, "name": "isLeaving", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 214, "character": 11 } ] }, { "id": 201, "name": "isMember", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 202, "name": "isMember", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 203, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 158, "character": 10 } ] }, { "id": 204, "name": "joinRef", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 205, "name": "joinRef", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 162, "character": 9 } ] }, { "id": 177, "name": "off", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 178, "name": "off", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 179, "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": 173, "name": "on", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 174, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 175, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 176, "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": 167, "name": "onClose", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 168, "name": "onClose", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 169, "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": 170, "name": "onError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 171, "name": "onError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 172, "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": 196, "name": "onMessage", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 197, "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": 198, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 199, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 200, "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": 154, "character": 11 } ] }, { "id": 182, "name": "push", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 183, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 184, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 15, "name": "CHANNEL_EVENTS", "dereferenced": { "id": 15, "name": "CHANNEL_EVENTS", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "children": [ { "id": 21, "name": "access_token", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 32, "character": 14 } ], "defaultValue": "\"access_token\"" }, { "id": 16, "name": "close", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 27, "character": 7 } ], "defaultValue": "\"phx_close\"" }, { "id": 17, "name": "error", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 28, "character": 7 } ], "defaultValue": "\"phx_error\"" }, { "id": 18, "name": "join", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 29, "character": 6 } ], "defaultValue": "\"phx_join\"" }, { "id": 20, "name": "leave", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 31, "character": 7 } ], "defaultValue": "\"phx_leave\"" }, { "id": 19, "name": "reply", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 30, "character": 7 } ], "defaultValue": "\"phx_reply\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [21, 16, 17, 18, 20, 19] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 26, "character": 26 } ] } } }, { "id": 185, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 186, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 101, "character": 6 } ] }, { "id": 206, "name": "rejoin", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 207, "name": "rejoin", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 208, "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": 166, "character": 8 } ] }, { "id": 162, "name": "rejoinUntilConnected", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 163, "name": "rejoinUntilConnected", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 64, "character": 22 } ] }, { "id": 214, "name": "replyEventName", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 215, "name": "replyEventName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 216, "name": "ref", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 198, "character": 16 } ] }, { "id": 164, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 165, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 166, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 71, "character": 11 } ] }, { "id": 209, "name": "trigger", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 210, "name": "trigger", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 211, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 212, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 213, "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": 175, "character": 9 } ] }, { "id": 193, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 194, "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": 195, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "this.timeout" } ], "type": { "type": "reference", "id": 74, "name": "Push" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 129, "character": 13 } ] }, { "id": 187, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 188, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 189, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 191, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 192, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 116, "character": 28 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 116, "character": 19 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [148] }, { "title": "Properties", "kind": 1024, "children": [141, 145, 144, 150, 147, 146, 154, 143, 142, 149] }, { "title": "Methods", "kind": 2048, "children": [ 180, 217, 219, 221, 223, 225, 201, 204, 177, 173, 167, 170, 196, 182, 206, 162, 214, 164, 209, 193, 187 ] } ], "sources": [ { "fileName": "RealtimeSubscription.ts", "line": 6, "character": 41 } ] } } }, { "id": 97, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "The event, for example `\"phx_join\"`" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 98, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "The payload, for example `{user_id: 123}`" }, "type": { "type": "reflection", "declaration": { "id": 99, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 100, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 101, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 29, "character": 19 } ] } }, "defaultValue": "{}" }, { "id": 102, "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": 74, "name": "Push" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 16, "character": 32 } ] }, { "id": 88, "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": 140, "name": "RealtimeSubscription" } }, { "id": 89, "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": 90, "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": "reflection", "declaration": { "id": 91, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 92, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 93, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 29, "character": 19 } ] } } }, { "id": 82, "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": 83, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 85, "name": "callback", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/push.ts", "line": 14, "character": 12 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 84, "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": [85, 84] } ], "sources": [ { "fileName": "lib/push.ts", "line": 12, "character": 11 } ] } } }, "defaultValue": "[]" }, { "id": 78, "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": 79, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 81, "name": "response", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/push.ts", "line": 10, "character": 12 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 80, "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": [81, 80] } ], "sources": [ { "fileName": "lib/push.ts", "line": 8, "character": 15 } ] } }, { "type": "intrinsic", "name": "null" } ] }, "defaultValue": "null" }, { "id": 77, "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": 86, "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": 75, "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": 94, "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": 76, "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": 126, "name": "_cancelRefEvent", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 127, "name": "_cancelRefEvent", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 100, "character": 25 } ] }, { "id": 128, "name": "_cancelTimeout", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 129, "name": "_cancelTimeout", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 108, "character": 24 } ] }, { "id": 136, "name": "_hasReceived", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 137, "name": "_hasReceived", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 138, "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": 125, "character": 22 } ] }, { "id": 130, "name": "_matchReceive", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 131, "name": "_matchReceive", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 132, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 135, "name": "response", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/push.ts", "line": 115, "character": 12 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 134, "name": "status", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/push.ts", "line": 114, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [135, 134] } ], "sources": [ { "fileName": "lib/push.ts", "line": 113, "character": 24 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 113, "character": 23 } ] }, { "id": 124, "name": "destroy", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 125, "name": "destroy", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 95, "character": 9 } ] }, { "id": 114, "name": "receive", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 115, "name": "receive", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 116, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 117, "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": 61, "character": 9 } ] }, { "id": 103, "name": "resend", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 104, "name": "resend", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 105, "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": 106, "name": "send", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 107, "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": 118, "name": "startTimeout", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 119, "name": "startTimeout", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 70, "character": 14 } ] }, { "id": 120, "name": "trigger", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 121, "name": "trigger", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 122, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 123, "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": 91, "character": 9 } ] }, { "id": 108, "name": "updatePayload", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 109, "name": "updatePayload", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 110, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 112, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 113, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 57, "character": 24 } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "lib/push.ts", "line": 57, "character": 15 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [87] }, { "title": "Properties", "kind": 1024, "children": [88, 89, 90, 82, 78, 77, 86, 75, 94, 76] }, { "title": "Methods", "kind": 2048, "children": [126, 128, 136, 130, 124, 114, 103, 106, 118, 120, 108] } ], "sources": [ { "fileName": "lib/push.ts", "line": 4, "character": 25 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [74] } ], "sources": [ { "fileName": "lib/push.ts", "line": 1, "character": 0 } ] }, { "id": 48, "name": "\"lib/serializer\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/lib/serializer.ts", "children": [ { "id": 49, "name": "Serializer", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 50, "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": 55, "name": "_binaryDecode", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 56, "name": "_binaryDecode", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 57, "name": "buffer", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "ArrayBuffer" } } ], "type": { "type": "reflection", "declaration": { "id": 58, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 61, "name": "event", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/serializer.ts", "line": 33, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 62, "name": "payload", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/serializer.ts", "line": 34, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 59, "name": "ref", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/serializer.ts", "line": 31, "character": 7 } ], "type": { "type": "intrinsic", "name": "null" } }, { "id": 60, "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": [61, 62, 59, 60] } ] } } } ], "sources": [ { "fileName": "lib/serializer.ts", "line": 19, "character": 23 } ] }, { "id": 63, "name": "_decodeBroadcast", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 64, "name": "_decodeBroadcast", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 65, "name": "buffer", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "ArrayBuffer" } }, { "id": 66, "name": "view", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "DataView" } }, { "id": 67, "name": "decoder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "TextDecoder" } } ], "type": { "type": "reflection", "declaration": { "id": 68, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 71, "name": "event", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/serializer.ts", "line": 33, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 72, "name": "payload", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/serializer.ts", "line": 34, "character": 11 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 69, "name": "ref", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/serializer.ts", "line": 31, "character": 7 } ], "type": { "type": "intrinsic", "name": "null" } }, { "id": 70, "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": [71, 72, 69, 70] } ], "sources": [ { "fileName": "lib/serializer.ts", "line": 30, "character": 4 } ] } } } ], "sources": [ { "fileName": "lib/serializer.ts", "line": 26, "character": 26 } ] }, { "id": 51, "name": "decode", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 52, "name": "decode", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 53, "name": "rawPayload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "union", "types": [ { "type": "reference", "name": "ArrayBuffer" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 54, "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": [50] }, { "title": "Methods", "kind": 2048, "children": [55, 63, 51] } ], "sources": [ { "fileName": "lib/serializer.ts", "line": 4, "character": 31 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [49] } ], "sources": [ { "fileName": "lib/serializer.ts", "line": 1, "character": 0 } ] }, { "id": 34, "name": "\"lib/timer\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/lib/timer.ts", "children": [ { "id": 35, "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": 38, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 41, "name": "new Timer", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 42, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "Function" } }, { "id": 43, "name": "timerCalc", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "Function" } } ], "type": { "type": "reference", "id": 35, "name": "Timer" } } ], "sources": [ { "fileName": "lib/timer.ts", "line": 15, "character": 19 } ] }, { "id": 39, "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": 36, "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": 40, "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": 37, "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": 44, "name": "reset", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 45, "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": 46, "name": "scheduleTimeout", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 47, "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": [38] }, { "title": "Properties", "kind": 1024, "children": [39, 36, 40, 37] }, { "title": "Methods", "kind": 2048, "children": [44, 46] } ], "sources": [ { "fileName": "lib/timer.ts", "line": 13, "character": 26 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [35] } ], "sources": [ { "fileName": "lib/timer.ts", "line": 1, "character": 0 } ] }, { "id": 371, "name": "\"lib/transformers\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/lib/transformers.ts", "children": [ { "id": 372, "name": "PostgresTypes", "kind": 4, "kindString": "Enumeration", "flags": { "isExported": true }, "comment": { "shortText": "Helpers to convert the change Payload into native JS types." }, "children": [ { "id": 373, "name": "abstime", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 9, "character": 9 } ], "defaultValue": "\"abstime\"" }, { "id": 374, "name": "bool", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 10, "character": 6 } ], "defaultValue": "\"bool\"" }, { "id": 375, "name": "date", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 11, "character": 6 } ], "defaultValue": "\"date\"" }, { "id": 376, "name": "daterange", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 12, "character": 11 } ], "defaultValue": "\"daterange\"" }, { "id": 377, "name": "float4", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 13, "character": 8 } ], "defaultValue": "\"float4\"" }, { "id": 378, "name": "float8", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 14, "character": 8 } ], "defaultValue": "\"float8\"" }, { "id": 379, "name": "int2", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 15, "character": 6 } ], "defaultValue": "\"int2\"" }, { "id": 380, "name": "int4", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 16, "character": 6 } ], "defaultValue": "\"int4\"" }, { "id": 381, "name": "int4range", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 17, "character": 11 } ], "defaultValue": "\"int4range\"" }, { "id": 382, "name": "int8", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 18, "character": 6 } ], "defaultValue": "\"int8\"" }, { "id": 383, "name": "int8range", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 19, "character": 11 } ], "defaultValue": "\"int8range\"" }, { "id": 384, "name": "json", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 20, "character": 6 } ], "defaultValue": "\"json\"" }, { "id": 385, "name": "jsonb", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 21, "character": 7 } ], "defaultValue": "\"jsonb\"" }, { "id": 386, "name": "money", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 22, "character": 7 } ], "defaultValue": "\"money\"" }, { "id": 387, "name": "numeric", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 23, "character": 9 } ], "defaultValue": "\"numeric\"" }, { "id": 388, "name": "oid", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 24, "character": 5 } ], "defaultValue": "\"oid\"" }, { "id": 389, "name": "reltime", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 25, "character": 9 } ], "defaultValue": "\"reltime\"" }, { "id": 390, "name": "text", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 26, "character": 6 } ], "defaultValue": "\"text\"" }, { "id": 391, "name": "time", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 27, "character": 6 } ], "defaultValue": "\"time\"" }, { "id": 392, "name": "timestamp", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 28, "character": 11 } ], "defaultValue": "\"timestamp\"" }, { "id": 393, "name": "timestamptz", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 29, "character": 13 } ], "defaultValue": "\"timestamptz\"" }, { "id": 394, "name": "timetz", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 30, "character": 8 } ], "defaultValue": "\"timetz\"" }, { "id": 395, "name": "tsrange", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 31, "character": 9 } ], "defaultValue": "\"tsrange\"" }, { "id": 396, "name": "tstzrange", "kind": 16, "kindString": "Enumeration member", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 32, "character": 11 } ], "defaultValue": "\"tstzrange\"" } ], "groups": [ { "title": "Enumeration members", "kind": 16, "children": [ 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396 ] } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 8, "character": 25 } ] }, { "id": 403, "name": "BaseValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 42, "character": 14 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" }, { "type": "intrinsic", "name": "boolean" } ] } }, { "id": 397, "name": "Columns", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 35, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 401, "name": "flags", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 38, "character": 7 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 399, "name": "name", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 36, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 400, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 37, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 402, "name": "type_modifier", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 39, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [401, 399, 400, 402] } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 35, "character": 14 } ] } } } }, { "id": 405, "name": "Record", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 45, "character": 11 } ], "type": { "type": "reflection", "declaration": { "id": 406, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 407, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 408, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 45, "character": 13 } ] } } }, { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } }, { "id": 422, "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', 't')\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": 423, "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', 't')\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": 424, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "A postgres column type" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 425, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 404, "name": "RecordValue", "dereferenced": { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } } } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 118, "character": 24 } ] }, { "id": 409, "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": 410, "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": 411, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 397, "name": "Columns", "dereferenced": { "id": 397, "name": "Columns", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 35, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 401, "name": "flags", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 38, "character": 7 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 399, "name": "name", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 36, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 400, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 37, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 402, "name": "type_modifier", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 39, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [401, 399, 400, 402] } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 35, "character": 14 } ] } } } } } }, { "id": 412, "name": "record", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": {}, "type": { "type": "reference", "id": 405, "name": "Record", "dereferenced": { "id": 405, "name": "Record", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 45, "character": 11 } ], "type": { "type": "reflection", "declaration": { "id": 406, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 407, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 408, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 45, "character": 13 } ] } } } } }, { "id": 413, "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": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 415, "name": "skipTypes", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 64, "character": 22 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [415] } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 64, "character": 10 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 405, "name": "Record" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 61, "character": 30 } ] }, { "id": 416, "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'}], {first_name: 'Paul', age: '33'}, [])\n//=> 33" }, { "tag": "example", "text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], {first_name: 'Paul', age: '33'}, ['int4'])\n//=> \"33\"\n" } ] }, "signatures": [ { "id": 417, "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'}], {first_name: 'Paul', age: '33'}, [])\n//=> 33" }, { "tag": "example", "text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], {first_name: 'Paul', age: '33'}, ['int4'])\n//=> \"33\"\n" } ] }, "parameters": [ { "id": 418, "name": "columnName", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "The column that you want to convert" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 419, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 397, "name": "Columns", "dereferenced": { "id": 397, "name": "Columns", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 35, "character": 12 } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 401, "name": "flags", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 38, "character": 7 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 399, "name": "name", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 36, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 400, "name": "type", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 37, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 402, "name": "type_modifier", "kind": 32, "kindString": "Variable", "flags": { "isOptional": true }, "sources": [ { "fileName": "lib/transformers.ts", "line": 39, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [401, 399, 400, 402] } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 35, "character": 14 } ] } } } } } }, { "id": 420, "name": "record", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "The map of string values" }, "type": { "type": "reference", "id": 405, "name": "Record", "dereferenced": { "id": 405, "name": "Record", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 45, "character": 11 } ], "type": { "type": "reflection", "declaration": { "id": 406, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 407, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 408, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 45, "character": 13 } ] } } } } }, { "id": 421, "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": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 88, "character": 26 } ] }, { "id": 426, "name": "noop", "kind": 64, "kindString": "Function", "flags": { "isConst": true }, "signatures": [ { "id": 427, "name": "noop", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 404, "name": "RecordValue", "dereferenced": { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } } } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 162, "character": 10 } ] }, { "id": 438, "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('{}', 'int4')\n//=> []" }, { "tag": "example", "text": "toArray('{\"[2021-01-01,2021-12-31)\",\"(2021-01-01,2021-12-32]\"}', 'daterange')\n//=> ['[2021-01-01,2021-12-31)', '(2021-01-01,2021-12-32]']" }, { "tag": "example", "text": "toArray([1,2,3,4], 'int4')\n//=> [1,2,3,4]\n" } ] }, "signatures": [ { "id": 439, "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('{}', 'int4')\n//=> []" }, { "tag": "example", "text": "toArray('{\"[2021-01-01,2021-12-31)\",\"(2021-01-01,2021-12-32]\"}', 'daterange')\n//=> ['[2021-01-01,2021-12-31)', '(2021-01-01,2021-12-32]']" }, { "tag": "example", "text": "toArray([1,2,3,4], 'int4')\n//=> [1,2,3,4]\n" } ] }, "parameters": [ { "id": 440, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 404, "name": "RecordValue", "dereferenced": { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } } } }, { "id": 441, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 206, "character": 20 } ] }, { "id": 429, "name": "toBoolean", "kind": 64, "kindString": "Function", "flags": { "isExported": true, "isConst": true }, "signatures": [ { "id": 430, "name": "toBoolean", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 431, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 404, "name": "RecordValue", "dereferenced": { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } } } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 165, "character": 22 } ] }, { "id": 435, "name": "toJson", "kind": 64, "kindString": "Function", "flags": { "isExported": true, "isConst": true }, "signatures": [ { "id": 436, "name": "toJson", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 437, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 404, "name": "RecordValue", "dereferenced": { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } } } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 184, "character": 19 } ] }, { "id": 432, "name": "toNumber", "kind": 64, "kindString": "Function", "flags": { "isExported": true, "isConst": true }, "signatures": [ { "id": 433, "name": "toNumber", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 434, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 404, "name": "RecordValue", "dereferenced": { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } } } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 175, "character": 21 } ] }, { "id": 442, "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": 443, "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": 444, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 404, "name": "RecordValue", "dereferenced": { "id": 404, "name": "RecordValue", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/transformers.ts", "line": 43, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 403, "name": "BaseValue" }, { "type": "array", "elementType": { "type": "reference", "id": 403, "name": "BaseValue" } } ] } } } } ], "type": { "type": "reference", "id": 404, "name": "RecordValue" } } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 241, "character": 30 } ] } ], "groups": [ { "title": "Enumerations", "kind": 4, "children": [372] }, { "title": "Type aliases", "kind": 4194304, "children": [403, 397, 405, 404] }, { "title": "Functions", "kind": 64, "children": [422, 409, 416, 426, 438, 429, 435, 432, 442] } ], "sources": [ { "fileName": "lib/transformers.ts", "line": 1, "character": 0 } ] }, { "id": 1, "name": "\"lib/version\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/realtime-js/src/lib/version.ts", "children": [ { "id": 2, "name": "version", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isConst": true }, "sources": [ { "fileName": "lib/version.ts", "line": 1, "character": 20 } ], "type": { "type": "stringLiteral", "value": "0.0.0-automated" }, "defaultValue": "\"0.0.0-automated\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [2] } ], "sources": [ { "fileName": "lib/version.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [227, 139, 445, 3, 73, 48, 34, 371, 1] } ] }, { "id": 0, "name": "@supabase/storage-js", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 312, "name": "\"StorageClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/StorageClient.ts", "children": [ { "id": 313, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 314, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 315, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 316, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 317, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 318, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 319, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 320, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "StorageClient.ts", "line": 5, "character": 35 } ] } }, "defaultValue": "{}" }, { "id": 321, "name": "fetch", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } } ], "type": { "type": "reference", "id": 313, "name": "StorageClient" }, "overwrites": { "type": "reference", "id": 114, "name": "StorageBucketApi.__constructor" } } ], "sources": [ { "fileName": "StorageClient.ts", "line": 4, "character": 53 } ], "overwrites": { "type": "reference", "id": 114, "name": "StorageBucketApi.__constructor" } }, { "id": 330, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 9, "character": 17 } ], "type": { "type": "reference", "id": 15, "name": "Fetch" }, "inheritedFrom": { "type": "reference", "id": 113, "name": "StorageBucketApi.fetch" } }, { "id": 326, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 8, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 327, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 328, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 329, "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": 20 } ] } }, "inheritedFrom": { "type": "reference", "id": 109, "name": "StorageBucketApi.headers" } }, { "id": 325, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 7, "character": 15 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 108, "name": "StorageBucketApi.url" } }, { "id": 342, "name": "createBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 343, "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": 344, "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": 345, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 346, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 347, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 51, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [347] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 51, "character": 12 } ] } }, "defaultValue": "{ public: false }" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 349, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 52, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 350, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 52, "character": 41 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [349, 350] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 52, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 133, "name": "StorageBucketApi.createBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 49, "character": 20 } ], "inheritedFrom": { "type": "reference", "id": 133, "name": "StorageBucketApi.createBucket" } }, { "id": 370, "name": "deleteBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 371, "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": 372, "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": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 374, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 375, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 376, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [376] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 377, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [374, 377] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 161, "name": "StorageBucketApi.deleteBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 115, "character": 20 } ], "inheritedFrom": { "type": "reference", "id": 161, "name": "StorageBucketApi.deleteBucket" } }, { "id": 362, "name": "emptyBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 363, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Removes all objects inside a single bucket." }, "parameters": [ { "id": 364, "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": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 366, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 368, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [368] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 369, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [366, 369] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 153, "name": "StorageBucketApi.emptyBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 93, "character": 19 } ], "inheritedFrom": { "type": "reference", "id": 153, "name": "StorageBucketApi.emptyBucket" } }, { "id": 322, "name": "from", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 323, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform file operation in a bucket." }, "parameters": [ { "id": 324, "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": 170, "name": "StorageFileApi" } } ], "sources": [ { "fileName": "StorageClient.ts", "line": 14, "character": 6 } ] }, { "id": 336, "name": "getBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 337, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves the details of an existing Storage bucket." }, "parameters": [ { "id": 338, "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": 339, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 340, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 45 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 74, "name": "Bucket" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 341, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 67 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [340, 341] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 39 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 127, "name": "StorageBucketApi.getBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 17 } ], "inheritedFrom": { "type": "reference", "id": 127, "name": "StorageBucketApi.getBucket" } }, { "id": 331, "name": "listBuckets", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 332, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves the details of all Storage buckets within an existing project." }, "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 334, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reference", "id": 74, "name": "Bucket" } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 335, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 61 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [334, 335] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 31 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 122, "name": "StorageBucketApi.listBuckets" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 19 } ], "inheritedFrom": { "type": "reference", "id": 122, "name": "StorageBucketApi.listBuckets" } }, { "id": 351, "name": "updateBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 352, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Updates a new Storage bucket" }, "parameters": [ { "id": 353, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A unique identifier for the bucket you are updating.\n" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 354, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 356, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 73, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [356] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 73, "character": 12 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 357, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 358, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 360, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [360] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 361, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [358, 361] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 142, "name": "StorageBucketApi.updateBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 71, "character": 20 } ], "inheritedFrom": { "type": "reference", "id": 142, "name": "StorageBucketApi.updateBucket" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [314] }, { "title": "Properties", "kind": 1024, "children": [330, 326, 325] }, { "title": "Methods", "kind": 2048, "children": [342, 370, 362, 322, 336, 331, 351] } ], "sources": [ { "fileName": "StorageClient.ts", "line": 4, "character": 26 } ], "extendedTypes": [ { "type": "reference", "id": 107, "name": "StorageBucketApi" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [313] } ], "sources": [ { "fileName": "StorageClient.ts", "line": 1, "character": 0 } ] }, { "id": 378, "name": "\"index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/index.ts", "children": [ { "id": 381, "name": "Bucket", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 74 }, { "id": 382, "name": "FileObject", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 81 }, { "id": 384, "name": "FileOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 95 }, { "id": 386, "name": "Metadata", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 104 }, { "id": 385, "name": "SearchOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 99 }, { "id": 383, "name": "SortBy", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 92 }, { "id": 379, "name": "StorageClient", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 313 }, { "id": 380, "name": "SupabaseStorageClient", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 313 } ], "groups": [ { "title": "References", "kind": 16777216, "children": [381, 382, 384, 386, 385, 383, 379, 380] } ], "sources": [ { "fileName": "index.ts", "line": 1, "character": 0 } ] }, { "id": 106, "name": "\"lib/StorageBucketApi\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/StorageBucketApi.ts", "children": [ { "id": 107, "name": "StorageBucketApi", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 114, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 115, "name": "new StorageBucketApi", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 116, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 117, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 119, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 120, "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": 11, "character": 35 } ] } }, "defaultValue": "{}" }, { "id": 121, "name": "fetch", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } } ], "type": { "type": "reference", "id": 107, "name": "StorageBucketApi" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 9, "character": 24 } ] }, { "id": 113, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 9, "character": 17 } ], "type": { "type": "reference", "id": 15, "name": "Fetch" } }, { "id": 109, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 8, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 110, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 111, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 112, "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": 20 } ] } } }, { "id": 108, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 7, "character": 15 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 133, "name": "createBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 134, "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": 135, "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": 136, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 137, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 138, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 51, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [138] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 51, "character": 12 } ] } }, "defaultValue": "{ public: false }" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 139, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 140, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 52, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 141, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 52, "character": 41 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [140, 141] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 52, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 49, "character": 20 } ] }, { "id": 161, "name": "deleteBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 162, "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": 163, "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": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 165, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 166, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 167, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [167] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 168, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [165, 168] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 117, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 115, "character": 20 } ] }, { "id": 153, "name": "emptyBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 154, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Removes all objects inside a single bucket." }, "parameters": [ { "id": 155, "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": 156, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 157, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 159, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [159] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 160, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [157, 160] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 95, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 93, "character": 19 } ] }, { "id": 127, "name": "getBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 128, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves the details of an existing Storage bucket." }, "parameters": [ { "id": 129, "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": 130, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 131, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 45 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 74, "name": "Bucket" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 132, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 67 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [131, 132] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 39 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 34, "character": 17 } ] }, { "id": 122, "name": "listBuckets", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 123, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves the details of all Storage buckets within an existing project." }, "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 125, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reference", "id": 74, "name": "Bucket" } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 126, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 61 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [125, 126] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 31 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 20, "character": 19 } ] }, { "id": 142, "name": "updateBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 143, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Updates a new Storage bucket" }, "parameters": [ { "id": 144, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A unique identifier for the bucket you are updating.\n" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 145, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 147, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 73, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [147] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 73, "character": 12 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 149, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 150, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 151, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [151] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 152, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [149, 152] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 74, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 71, "character": 20 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [114] }, { "title": "Properties", "kind": 1024, "children": [113, 109, 108] }, { "title": "Methods", "kind": 2048, "children": [133, 161, 153, 127, 122, 142] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 6, "character": 29 } ], "extendedBy": [ { "type": "reference", "id": 313, "name": "StorageClient" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [107] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 1, "character": 0 } ] }, { "id": 169, "name": "\"lib/StorageFileApi\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/StorageFileApi.ts", "children": [ { "id": 170, "name": "StorageFileApi", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 178, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 179, "name": "new StorageFileApi", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 180, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 181, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 183, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 184, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 28, "character": 12 } ] } }, "defaultValue": "{}" }, { "id": 185, "name": "bucketId", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 186, "name": "fetch", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } } ], "type": { "type": "reference", "id": 170, "name": "StorageFileApi" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 24, "character": 24 } ] }, { "id": 176, "name": "bucketId", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 23, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 177, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 24, "character": 17 } ], "type": { "type": "reference", "id": 15, "name": "Fetch" } }, { "id": 172, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 22, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 173, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 174, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 175, "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": 22, "character": 20 } ] } } }, { "id": 171, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 21, "character": 15 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 286, "name": "_getFinalPath", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 287, "name": "_getFinalPath", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 288, "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": 387, "character": 15 } ] }, { "id": 289, "name": "_removeEmptyFolders", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 290, "name": "_removeEmptyFolders", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 291, "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": 391, "character": 21 } ] }, { "id": 227, "name": "copy", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 228, "name": "copy", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Copies an existing file." }, "parameters": [ { "id": 229, "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": 230, "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": 231, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 232, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 195, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 234, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 195, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [234] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 195, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 235, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 195, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [232, 235] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 195, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 192, "character": 12 } ] }, { "id": 236, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 237, "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": 238, "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": 239, "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": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 241, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 219, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 243, "name": "signedURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 219, "character": 21 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [243] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 219, "character": 9 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 244, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 220, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 245, "name": "signedURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 221, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [241, 244, 245] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 218, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 215, "character": 23 } ] }, { "id": 246, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 247, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Create signed URLs to download files without requiring permissions. These URLs can be valid for a set number of seconds." }, "parameters": [ { "id": 248, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 249, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute.\n" }, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 250, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 251, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 249, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 252, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 253, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 249, "character": 17 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 254, "name": "path", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 249, "character": 38 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 255, "name": "signedURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 249, "character": 64 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [253, 254, 255] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 249, "character": 9 } ] } } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 256, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 250, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [251, 256] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 248, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 245, "character": 24 } ] }, { "id": 257, "name": "download", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 258, "name": "download", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Downloads a file." }, "parameters": [ { "id": 259, "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": 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": "lib/StorageFileApi.ts", "line": 276, "character": 46 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Blob" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 262, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 276, "character": 66 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [261, 262] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 276, "character": 40 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 276, "character": 16 } ] }, { "id": 263, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 264, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieve URLs for assets in public buckets" }, "parameters": [ { "id": 265, "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": 266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 267, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 298, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 269, "name": "publicURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 298, "character": 21 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [269] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 298, "character": 9 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 270, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 299, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 271, "name": "publicURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 300, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [267, 270, 271] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 297, "character": 4 } ] } } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 295, "character": 14 } ] }, { "id": 278, "name": "list", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 279, "name": "list", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Lists all the files within a bucket." }, "parameters": [ { "id": 280, "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": 281, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "Search options, including `limit`, `offset`, `sortBy`, and `search`." }, "type": { "type": "reference", "id": 99, "name": "SearchOptions", "dereferenced": { "id": 99, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 100, "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": 101, "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": 103, "name": "search", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The search string to filter files by." }, "sources": [ { "fileName": "lib/types.ts", "line": 44, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 102, "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": 92, "name": "SortBy" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [100, 101, 103, 102] } ], "sources": [ { "fileName": "lib/types.ts", "line": 33, "character": 30 } ] } } }, { "id": 282, "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": 13, "name": "FetchParameters", "dereferenced": { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 283, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 284, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 371, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reference", "id": 81, "name": "FileObject" } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 285, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 371, "character": 47 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [284, 285] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 371, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 367, "character": 12 } ] }, { "id": 218, "name": "move", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 219, "name": "move", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Moves an existing file." }, "parameters": [ { "id": 220, "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": 221, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The new file path, including the new file name. For example `folder/image-new.png`.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "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": 172, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 225, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 172, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [225] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 172, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 226, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 172, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [223, 226] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 172, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 169, "character": 12 } ] }, { "id": 272, "name": "remove", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 273, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Deletes files within the same bucket" }, "parameters": [ { "id": 274, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "An array of files to be deleted, 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": 275, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 276, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 317, "character": 47 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reference", "id": 81, "name": "FileObject" } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 277, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 317, "character": 75 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [276, 277] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 317, "character": 41 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 317, "character": 14 } ] }, { "id": 208, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 209, "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": 210, "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": 211, "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": 212, "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": 95, "name": "FileOptions", "dereferenced": { "id": 95, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 96, "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": 97, "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": 98, "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": [96, 97, 98] } ], "sources": [ { "fileName": "lib/types.ts", "line": 27, "character": 28 } ] } } } ], "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": 159, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 215, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 216, "name": "Key", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 159, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [216] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 159, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 217, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 159, "character": 50 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [214, 217] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 159, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 145, "character": 14 } ] }, { "id": 198, "name": "upload", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 199, "name": "upload", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Uploads a file to an existing bucket." }, "parameters": [ { "id": 200, "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": 201, "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": 202, "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": 95, "name": "FileOptions", "dereferenced": { "id": 95, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 96, "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": 97, "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": 98, "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": [96, 97, 98] } ], "sources": [ { "fileName": "lib/types.ts", "line": 27, "character": 28 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 204, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 131, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 206, "name": "Key", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 131, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [206] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 131, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 207, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 131, "character": 50 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [204, 207] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 131, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 117, "character": 14 } ] }, { "id": 187, "name": "uploadOrUpdate", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 188, "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": 189, "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": 190, "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": 191, "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": 192, "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": 95, "name": "FileOptions", "dereferenced": { "id": 95, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 96, "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": 97, "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": 98, "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": [96, 97, 98] } ], "sources": [ { "fileName": "lib/types.ts", "line": 27, "character": 28 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 193, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 194, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 64, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 195, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 196, "name": "Key", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 64, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [196] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 64, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 197, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 64, "character": 50 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [194, 197] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 64, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 49, "character": 30 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [178] }, { "title": "Properties", "kind": 1024, "children": [176, 177, 172, 171] }, { "title": "Methods", "kind": 2048, "children": [286, 289, 227, 236, 246, 257, 263, 278, 218, 272, 208, 198, 187] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 20, "character": 27 } ] }, { "id": 298, "name": "DEFAULT_FILE_OPTIONS", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 299, "name": "cacheControl", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 15, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"3600\"" }, { "id": 300, "name": "contentType", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 16, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"text/plain;charset=UTF-8\"" }, { "id": 301, "name": "upsert", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 17, "character": 8 } ], "type": { "type": "intrinsic", "name": "false" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [299, 300, 301] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 14, "character": 26 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 292, "name": "DEFAULT_SEARCH_OPTIONS", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 293, "name": "limit", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 6, "character": 7 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "100" }, { "id": 294, "name": "offset", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 7, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 295, "name": "sortBy", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 296, "name": "column", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 9, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"name\"" }, { "id": 297, "name": "order", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 10, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"asc\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [296, 297] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 8, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [293, 294] }, { "title": "Object literals", "kind": 2097152, "children": [295] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 5, "character": 28 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [170] }, { "title": "Object literals", "kind": 2097152, "children": [298, 292] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 1, "character": 0 } ] }, { "id": 3, "name": "\"lib/constants\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/constants.ts", "children": [ { "id": 4, "name": "DEFAULT_HEADERS", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true, "isConst": true }, "children": [ { "id": 5, "name": "X-Client-Info", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/constants.ts", "line": 2, "character": 48 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "`storage-js/${version}`" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [5] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 2, "character": 28 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Object literals", "kind": 2097152, "children": [4] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 1, "character": 0 } ] }, { "id": 6, "name": "\"lib/fetch\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/fetch.ts", "children": [ { "id": 7, "name": "FetchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 8, "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": 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": 12, "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": [8, 12] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 3, "character": 29 } ] }, { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] }, { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } }, { "id": 16, "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": 17, "name": "_getErrorMessage", "kind": 64, "kindString": "Function", "flags": { "isConst": true }, "signatures": [ { "id": 18, "name": "_getErrorMessage", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 19, "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": 24, "name": "_getRequestParams", "kind": 64, "kindString": "Function", "flags": { "isConst": true }, "signatures": [ { "id": 25, "name": "_getRequestParams", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 26, "name": "method", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 16, "name": "RequestMethodType", "dereferenced": { "id": 16, "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": 27, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 7, "name": "FetchOptions", "dereferenced": { "id": 7, "name": "FetchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 8, "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": 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": 12, "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": [8, 12] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 3, "character": 29 } ] } } }, { "id": 28, "name": "parameters", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 13, "name": "FetchParameters", "dereferenced": { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] } } }, { "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": "reflection", "declaration": { "id": 30, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": [ { "id": 31, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 32, "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": 33, "name": "_handleRequest", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 34, "name": "_handleRequest", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 35, "name": "fetcher", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } }, { "id": 36, "name": "method", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 16, "name": "RequestMethodType", "dereferenced": { "id": 16, "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": 37, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 38, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 7, "name": "FetchOptions", "dereferenced": { "id": 7, "name": "FetchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 8, "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": 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": 12, "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": [8, 12] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 3, "character": 29 } ] } } }, { "id": 39, "name": "parameters", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 13, "name": "FetchParameters", "dereferenced": { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] } } }, { "id": 40, "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": 41, "name": "get", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 42, "name": "get", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 43, "name": "fetcher", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } }, { "id": 44, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 45, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 7, "name": "FetchOptions", "dereferenced": { "id": 7, "name": "FetchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 8, "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": 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": 12, "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": [8, 12] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 3, "character": 29 } ] } } }, { "id": 46, "name": "parameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 13, "name": "FetchParameters", "dereferenced": { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 68, "character": 25 } ] }, { "id": 20, "name": "handleError", "kind": 64, "kindString": "Function", "flags": { "isConst": true }, "signatures": [ { "id": 21, "name": "handleError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 22, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } }, { "id": 23, "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": 47, "name": "post", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 48, "name": "post", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 49, "name": "fetcher", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } }, { "id": 50, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 51, "name": "body", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "object" } }, { "id": 52, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 7, "name": "FetchOptions", "dereferenced": { "id": 7, "name": "FetchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 8, "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": 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": 12, "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": [8, 12] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 3, "character": 29 } ] } } }, { "id": 53, "name": "parameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 13, "name": "FetchParameters", "dereferenced": { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 77, "character": 26 } ] }, { "id": 54, "name": "put", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 55, "name": "put", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 56, "name": "fetcher", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } }, { "id": 57, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 58, "name": "body", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "object" } }, { "id": 59, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 7, "name": "FetchOptions", "dereferenced": { "id": 7, "name": "FetchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 8, "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": 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": 12, "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": [8, 12] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 3, "character": 29 } ] } } }, { "id": 60, "name": "parameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 13, "name": "FetchParameters", "dereferenced": { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 87, "character": 25 } ] }, { "id": 61, "name": "remove", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 62, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 63, "name": "fetcher", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 15, "name": "Fetch", "dereferenced": { "id": 15, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 17 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } }, { "id": 64, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 65, "name": "body", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "object" } }, { "id": 66, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 7, "name": "FetchOptions", "dereferenced": { "id": 7, "name": "FetchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 8, "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": 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": 12, "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": [8, 12] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 3, "character": 29 } ] } } }, { "id": 67, "name": "parameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 13, "name": "FetchParameters", "dereferenced": { "id": 13, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 14, "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": [14] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 10, "character": 32 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 97, "character": 28 } ] } ], "groups": [ { "title": "Interfaces", "kind": 256, "children": [7, 13] }, { "title": "Type aliases", "kind": 4194304, "children": [15, 16] }, { "title": "Functions", "kind": 64, "children": [17, 24, 33, 41, 20, 47, 54, 61] } ], "sources": [ { "fileName": "lib/fetch.ts", "line": 1, "character": 0 } ] }, { "id": 68, "name": "\"lib/helpers\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/helpers.ts", "children": [ { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/helpers.ts", "line": 1, "character": 10 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } }, { "id": 70, "name": "resolveFetch", "kind": 64, "kindString": "Function", "flags": { "isExported": true, "isConst": true }, "signatures": [ { "id": 71, "name": "resolveFetch", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 72, "name": "customFetch", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 69, "name": "Fetch", "dereferenced": { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/helpers.ts", "line": 1, "character": 10 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "fetch" } } } } } ], "type": { "type": "reference", "id": 69, "name": "Fetch" } } ], "sources": [ { "fileName": "lib/helpers.ts", "line": 3, "character": 25 } ] } ], "groups": [ { "title": "Type aliases", "kind": 4194304, "children": [69] }, { "title": "Functions", "kind": 64, "children": [70] } ], "sources": [ { "fileName": "lib/helpers.ts", "line": 1, "character": 0 } ] }, { "id": 302, "name": "\"lib/index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/index.ts", "children": [ { "id": 305, "name": "Bucket", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 74 }, { "id": 311, "name": "DEFAULT_HEADERS", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 4 }, { "id": 306, "name": "FileObject", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 81 }, { "id": 308, "name": "FileOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 95 }, { "id": 310, "name": "Metadata", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 104 }, { "id": 309, "name": "SearchOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 99 }, { "id": 307, "name": "SortBy", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 92 }, { "id": 303, "name": "StorageBucketApi", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 107 }, { "id": 304, "name": "StorageFileApi", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 170 } ], "groups": [ { "title": "References", "kind": 16777216, "children": [305, 311, 306, 308, 310, 309, 307, 303, 304] } ], "sources": [ { "fileName": "lib/index.ts", "line": 1, "character": 0 } ] }, { "id": 73, "name": "\"lib/types\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/types.ts", "children": [ { "id": 74, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 78, "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": 75, "name": "id", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 2, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 76, "name": "name", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 3, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 77, "name": "owner", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 4, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 80, "name": "public", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 7, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 79, "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": [78, 75, 76, 77, 80, 79] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 23 } ] }, { "id": 81, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 83, "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": 91, "name": "buckets", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 19, "character": 9 } ], "type": { "type": "reference", "id": 74, "name": "Bucket" } }, { "id": 87, "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": 85, "name": "id", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 14, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 88, "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": 89, "name": "metadata", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 18, "character": 10 } ], "type": { "type": "reflection", "declaration": { "id": 90, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 18, "character": 11 } ] } } }, { "id": 82, "name": "name", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 11, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 84, "name": "owner", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 13, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 86, "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": [83, 91, 87, 85, 88, 89, 82, 84, 86] } ], "sources": [ { "fileName": "lib/types.ts", "line": 10, "character": 27 } ] }, { "id": 95, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 96, "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": 97, "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": 98, "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": [96, 97, 98] } ], "sources": [ { "fileName": "lib/types.ts", "line": 27, "character": 28 } ] }, { "id": 104, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 105, "name": "name", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 49, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [105] } ], "sources": [ { "fileName": "lib/types.ts", "line": 48, "character": 25 } ] }, { "id": 99, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 100, "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": 101, "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": 103, "name": "search", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The search string to filter files by." }, "sources": [ { "fileName": "lib/types.ts", "line": 44, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 102, "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": 92, "name": "SortBy" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [100, 101, 103, 102] } ], "sources": [ { "fileName": "lib/types.ts", "line": 33, "character": 30 } ] }, { "id": 92, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 93, "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": 94, "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": [93, 94] } ], "sources": [ { "fileName": "lib/types.ts", "line": 22, "character": 23 } ] } ], "groups": [ { "title": "Interfaces", "kind": 256, "children": [74, 81, 95, 104, 99, 92] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 0 } ] }, { "id": 1, "name": "\"lib/version\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/Users/copple/Projects/Supabase/storage-js/src/lib/version.ts", "children": [ { "id": 2, "name": "version", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isConst": true }, "sources": [ { "fileName": "lib/version.ts", "line": 2, "character": 20 } ], "type": { "type": "stringLiteral", "value": "0.0.0" }, "defaultValue": "\"0.0.0\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [2] } ], "sources": [ { "fileName": "lib/version.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [312, 378, 106, 169, 3, 6, 68, 302, 73, 1] } ] }, { "id": 0, "name": "@supabase/functions-js", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 1, "name": "FunctionsClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 2, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 9, "character": 2 } ], "signatures": [ { "id": 3, "name": "new FunctionsClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 4, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 5, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 6, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 8, "name": "customFetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/index.ts", "line": 16, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 9, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 10, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 11, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" } }, { "id": 12, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 7, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/index.ts", "line": 15, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [8, 7] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 1, "name": "FunctionsClient" } } ] }, { "id": 15, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/index.ts", "line": 7, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 16, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 17, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 18, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" } }, { "id": 19, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 14, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/index.ts", "line": 6, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 13, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/index.ts", "line": 5, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 23, "name": "invoke", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 40, "character": 8 } ], "signatures": [ { "id": 24, "name": "invoke", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Invokes a function" }, "typeParameter": [ { "id": 25, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "parameters": [ { "id": 26, "name": "functionName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "the name of the function to invoke" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 27, "name": "invokeOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "object with the following properties\n`headers`: object representing the headers to send with the request\n`body`: the body of the request\n`responseType`: how the response should be parsed. The default is `json`\n" }, "type": { "type": "reference", "name": "FunctionInvokeOptions" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 28, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 29, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 43, "character": 15 } ], "type": { "type": "reference", "id": 25, "name": "T" } }, { "id": 30, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 43, "character": 24 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [29, 30] } ] } }, { "type": "reflection", "declaration": { "id": 31, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 32, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 43, "character": 42 } ], "type": { "type": "literal", "value": null } }, { "id": 33, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 43, "character": 54 } ], "type": { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [32, 33] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 20, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 28, "character": 2 } ], "signatures": [ { "id": 21, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates the authorization header", "tags": [ { "tag": "params", "text": "token - the new jwt token sent in the authorisation header\n" } ] }, "parameters": [ { "id": 22, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [2] }, { "title": "Properties", "kind": 1024, "children": [15, 14, 13] }, { "title": "Methods", "kind": 2048, "children": [23, 20] } ], "sources": [ { "fileName": "src/index.ts", "line": 4, "character": 13 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [1] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] } ] }