{ "name": "Combined Specs", "children": [ { "id": 0, "name": "@supabase/supabase-js", "kind": 1, "flags": {}, "originalName": "", "children": [ { "id": 1, "name": "index", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 213, "name": "QueryData", "kind": 16777216, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, "character": 50 } ], "target": 112 }, { "id": 214, "name": "QueryError", "kind": 16777216, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, "character": 61 } ], "target": 116 }, { "id": 212, "name": "QueryResult", "kind": 16777216, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, "character": 37 } ], "target": 110 }, { "id": 211, "name": "SupabaseClientOptions", "kind": 16777216, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, "character": 14 } ], "target": 70 }, { "id": 119, "name": "SupabaseClient", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "Supabase Client.", "text": "An isomorphic Javascript client for interacting with Postgres.\n" }, "children": [ { "id": 120, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 69, "character": 2 } ], "signatures": [ { "id": 121, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Create a new client for use in the browser." }, "typeParameter": [ { "id": 122, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 123, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 122, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 122, "name": "Database" } } ] } } }, { "id": 124, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 105, "name": "GenericSchema" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 123, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 122, "name": "Database" } }, "extendsType": { "type": "reference", "id": 105, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ], "parameters": [ { "id": 125, "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": 126, "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": 127, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 70, "typeArguments": [ { "type": "reference", "id": 123, "name": "SchemaName" } ], "name": "SupabaseClientOptions", "dereferenced": { "id": 70, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 12 } ], "typeParameter": [ { "id": 90, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reflection", "declaration": { "id": 71, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 75, "name": "auth", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 77, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 23, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 83, "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 47, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "debug" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 80, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 35, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 82, "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "flowType" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 53, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "lock" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 79, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged-in session to storage. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 31, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 81, "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged-in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 39, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "storage" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 78, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional key name used for storing tokens in local storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 27, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [77, 83, 80, 82, 84, 79, 81, 78] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 9 } ] } } }, { "id": 72, "name": "db", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 73, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 74, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 4 } ], "type": { "type": "reference", "id": 90, "name": "SchemaName", "dereferenced": {} } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [74] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 7 } ] } } }, { "id": 86, "name": "global", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 88, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 4 } ], "type": { "type": "reference", "id": 69, "name": "Fetch", "dereferenced": { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 12 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 28, "qualifiedName": "fetch", "package": "typescript", "name": "fetch" } } } } }, { "id": 89, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [88, 89] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 11 } ] } } }, { "id": 85, "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": 58, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClientOptions", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 48 } ] } } } } } ], "type": { "type": "reference", "id": 119, "typeArguments": [ { "type": "reference", "id": 122, "name": "Database" }, { "type": "reference", "id": 123, "name": "SchemaName" }, { "type": "reference", "id": 124, "name": "Schema" } ], "name": "default" } } ] }, { "id": 128, "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": 43, "character": 2 } ], "type": { "type": "reference", "name": "SupabaseAuthClient" } }, { "id": 131, "name": "authUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 47, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 141, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 53, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 136, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 52, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 137, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 138, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 139, "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": 140, "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": 133, "name": "functionsUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 49, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 142, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 55, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 129, "name": "realtime", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 44, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClient", "package": "@supabase/realtime-js", "name": "default" } }, { "id": 130, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 46, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 134, "name": "rest", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 50, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 122, "name": "Database" }, { "type": "reference", "id": 123, "name": "SchemaName" }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 123, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 122, "name": "Database" } }, "extendsType": { "type": "reference", "qualifiedName": "GenericSchema", "package": "@supabase/postgrest-js", "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } ], "qualifiedName": "PostgrestClient", "package": "@supabase/postgrest-js", "name": "default" } }, { "id": 135, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 51, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 132, "name": "storageUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 48, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 144, "name": "supabaseKey", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 143, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 145, "name": "functions", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 118, "character": 6 } ], "getSignature": [ { "id": 146, "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": 147, "name": "storage", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 128, "character": 6 } ], "getSignature": [ { "id": 148, "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": 186, "name": "_getAccessToken", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 246, "character": 16 } ], "signatures": [ { "id": 187, "name": "_getAccessToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 203, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 297, "character": 10 } ], "signatures": [ { "id": 204, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 205, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "AuthChangeEvent", "package": "@supabase/auth-js", "name": "AuthChangeEvent" } }, { "id": 206, "name": "source", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "CLIENT" }, { "type": "literal", "value": "STORAGE" } ] } }, { "id": 207, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 197, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 283, "character": 10 } ], "signatures": [ { "id": 198, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 199, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RealtimeClientOptions", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } } ], "type": { "type": "reference", "qualifiedName": "RealtimeClient", "package": "@supabase/realtime-js", "name": "default" } } ] }, { "id": 188, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 252, "character": 10 } ], "signatures": [ { "id": 189, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 190, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions", "dereferenced": { "id": 68, "name": "SupabaseAuthClientOptions", "kind": 256, "kindString": "Interface", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 7, "character": 17 } ], "extendedTypes": [ { "type": "reference", "name": "AuthClientOptions" } ] } } }, { "id": 191, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 192, "name": "fetch", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 193, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 194, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 195, "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": 196, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "name": "SupabaseAuthClient" } } ] }, { "id": 200, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 290, "character": 10 } ], "signatures": [ { "id": 201, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } } ] }, { "id": 175, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 218, "character": 2 } ], "signatures": [ { "id": 176, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." }, "parameters": [ { "id": 177, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The name of the Realtime channel." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 178, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The options to pass to the Realtime channel.\n\n" }, "type": { "type": "reference", "qualifiedName": "RealtimeChannelOptions", "package": "@supabase/realtime-js", "name": "RealtimeChannelOptions" }, "defaultValue": "..." } ], "type": { "type": "reference", "qualifiedName": "RealtimeChannel", "package": "@supabase/realtime-js", "name": "default" } } ] }, { "id": 149, "name": "from", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 133, "character": 2 } ], "signatures": [ { "id": 150, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { "id": 151, "name": "TableName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 152, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 91, "name": "GenericTable" } } ], "parameters": [ { "id": 153, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table or view name to query\n" }, "type": { "type": "reference", "id": 151, "name": "TableName", "dereferenced": {} } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 124, "name": "Schema" }, { "type": "reference", "id": 152, "name": "Table" }, { "type": "reference", "id": 151, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", "id": 152, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { "id": 154, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } }, "trueType": { "type": "reference", "qualifiedName": "R", "package": "@supabase/postgrest-js", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } ], "qualifiedName": "PostgrestQueryBuilder", "package": "@supabase/postgrest-js", "name": "default" } }, { "id": 155, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { "id": 156, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 157, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 100, "name": "GenericView" } } ], "parameters": [ { "id": 158, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table or view name to query\n" }, "type": { "type": "reference", "id": 156, "name": "ViewName", "dereferenced": {} } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 124, "name": "Schema" }, { "type": "reference", "id": 157, "name": "View" }, { "type": "reference", "id": 156, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", "id": 157, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } }, "trueType": { "type": "reference", "qualifiedName": "R", "package": "@supabase/postgrest-js", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } ], "qualifiedName": "PostgrestQueryBuilder", "package": "@supabase/postgrest-js", "name": "default" } } ] }, { "id": 179, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 225, "character": 2 } ], "signatures": [ { "id": 180, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all Realtime channels." }, "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "RealtimeChannel", "package": "@supabase/realtime-js", "name": "default" } } } ] }, { "id": 184, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 242, "character": 2 } ], "signatures": [ { "id": 185, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "union", "types": [ { "type": "literal", "value": "error" }, { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 181, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 235, "character": 2 } ], "signatures": [ { "id": 182, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes Realtime channel from Realtime client." }, "parameters": [ { "id": 183, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The name of the Realtime channel.\n\n" }, "type": { "type": "reference", "qualifiedName": "RealtimeChannel", "package": "@supabase/realtime-js", "name": "default" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "error" }, { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 164, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 191, "character": 2 } ], "signatures": [ { "id": 165, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a function call." }, "typeParameter": [ { "id": 166, "name": "FnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 167, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 101, "name": "GenericFunction" } } ], "parameters": [ { "id": 168, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The function name to call" }, "type": { "type": "reference", "id": 166, "name": "FnName", "dereferenced": {} } }, { "id": 169, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The arguments to pass to the function call" }, "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Args" }, "objectType": { "type": "reference", "id": 167, "name": "Fn" } }, "defaultValue": "{}" }, { "id": 170, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 174, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 197, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 173, "name": "get", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When set to `true`, the function will be called with\nread-only access mode." }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 196, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 172, "name": "head", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 195, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [174, 173, 172] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 124, "name": "Schema" }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Returns" }, "objectType": { "type": "reference", "id": 167, "name": "Fn" } }, "extendsType": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } }, "trueType": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } } }, "extendsType": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "never" } }, "falseType": { "type": "intrinsic", "name": "never" } }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Returns" }, "objectType": { "type": "reference", "id": 167, "name": "Fn" } }, { "type": "intrinsic", "name": "unknown" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "name": "default" } } ] }, { "id": 160, "name": "schema", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 161, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Select a schema to query or perform an function (rpc) call.", "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" }, "typeParameter": [ { "id": 162, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 163, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The schema to query\n" }, "type": { "type": "reference", "id": 162, "name": "DynamicSchema", "dereferenced": {} } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 122, "name": "Database" }, { "type": "reference", "id": 162, "name": "DynamicSchema" }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 162, "name": "DynamicSchema" }, "objectType": { "type": "reference", "id": 122, "name": "Database" } }, "extendsType": { "type": "reference", "id": 105, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } ], "qualifiedName": "PostgrestClient", "package": "@supabase/postgrest-js", "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [120] }, { "title": "Properties", "kind": 1024, "children": [128, 131, 141, 136, 133, 142, 129, 130, 134, 135, 132, 144, 143] }, { "title": "Accessors", "kind": 262144, "children": [145, 147] }, { "title": "Methods", "kind": 2048, "children": [186, 203, 197, 188, 200, 175, 149, 179, 184, 181, 164, 160] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 31, "character": 21 } ], "typeParameter": [ { "id": 208, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 209, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 122, "name": "Database" } } ] }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 122, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 122, "name": "Database" } } ] } } }, { "id": 210, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 105, "name": "GenericSchema" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 123, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 122, "name": "Database" } }, "extendsType": { "type": "reference", "id": 105, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 123, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 122, "name": "Database" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ] }, { "id": 2, "name": "createClient", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 27, "character": 13 } ], "signatures": [ { "id": 3, "name": "createClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new Supabase Client." }, "typeParameter": [ { "id": 4, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 5, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } } ] } } }, { "id": 6, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "id": 105, "name": "GenericSchema" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 5, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "extendsType": { "type": "reference", "id": 105, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ], "parameters": [ { "id": 7, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 8, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 9, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 70, "typeArguments": [ { "type": "reference", "id": 5, "name": "SchemaName" } ], "name": "SupabaseClientOptions", "dereferenced": { "id": 70, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 12 } ], "typeParameter": [ { "id": 90, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reflection", "declaration": { "id": 71, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 75, "name": "auth", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 77, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 23, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 83, "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 47, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "debug" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 80, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 35, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 82, "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "flowType" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 53, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "lock" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 79, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged-in session to storage. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 31, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 81, "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged-in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 39, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "storage" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 78, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional key name used for storing tokens in local storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 27, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [77, 83, 80, 82, 84, 79, 81, 78] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 9 } ] } } }, { "id": 72, "name": "db", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 73, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 74, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 4 } ], "type": { "type": "reference", "id": 90, "name": "SchemaName", "dereferenced": {} } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [74] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 7 } ] } } }, { "id": 86, "name": "global", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 88, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 4 } ], "type": { "type": "reference", "id": 69, "name": "Fetch", "dereferenced": { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 12 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 28, "qualifiedName": "fetch", "package": "typescript", "name": "fetch" } } } } }, { "id": 89, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [88, 89] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 11 } ] } } }, { "id": 85, "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": 58, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClientOptions", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 48 } ] } } } } } ], "type": { "type": "reference", "id": 119, "typeArguments": [ { "type": "reference", "id": 4, "name": "Database" }, { "type": "reference", "id": 5, "name": "SchemaName" }, { "type": "reference", "id": 6, "name": "Schema" } ], "name": "default" } } ] } ], "groups": [ { "title": "References", "kind": 16777216, "children": [213, 214, 212, 211] }, { "title": "Classes", "kind": 128, "children": [119] }, { "title": "Functions", "kind": 64, "children": [2] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 10, "name": "lib/constants", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 22, "name": "DEFAULT_AUTH_OPTIONS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/constants.ts", "line": 28, "character": 13 } ], "type": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" }, "defaultValue": "..." }, { "id": 19, "name": "DEFAULT_DB_OPTIONS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/constants.ts", "line": 24, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 20, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 21, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/constants.ts", "line": 25, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "'public'" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [21] } ] } }, "defaultValue": "..." }, { "id": 14, "name": "DEFAULT_GLOBAL_OPTIONS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/constants.ts", "line": 20, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 15, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 16, "name": "headers", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/constants.ts", "line": 21, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 17, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 18, "name": "X-Client-Info", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/constants.ts", "line": 18, "character": 33 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [18] } ] } }, "defaultValue": "DEFAULT_HEADERS" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [16] } ] } }, "defaultValue": "..." }, { "id": 11, "name": "DEFAULT_HEADERS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/constants.ts", "line": 18, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 12, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 13, "name": "X-Client-Info", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/constants.ts", "line": 18, "character": 33 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [13] } ] } }, "defaultValue": "..." }, { "id": 23, "name": "DEFAULT_REALTIME_OPTIONS", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/lib/constants.ts", "line": 35, "character": 13 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClientOptions", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" }, "defaultValue": "{}" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [22, 19, 14, 11, 23] } ], "sources": [ { "fileName": "src/lib/constants.ts", "line": 2, "character": 0 } ] }, { "id": 24, "name": "lib/fetch", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 38, "name": "fetchWithAuth", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/fetch.ts", "line": 26, "character": 13 } ], "signatures": [ { "id": 39, "name": "fetchWithAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 40, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 41, "name": "getAccessToken", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 42, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 43, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 44, "name": "customFetch", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 45, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 46, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 47, "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": 48, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 49, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 50, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 51, "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": 52, "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": 25, "name": "resolveFetch", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/fetch.ts", "line": 6, "character": 13 } ], "signatures": [ { "id": 26, "name": "resolveFetch", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 27, "name": "customFetch", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "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": "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": 31, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 32, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 33, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 34, "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": 35, "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": 36, "name": "resolveHeadersConstructor", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/fetch.ts", "line": 18, "character": 13 } ], "signatures": [ { "id": 37, "name": "resolveHeadersConstructor", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ] } ], "groups": [ { "title": "Functions", "kind": 64, "children": [38, 25, 36] } ], "sources": [ { "fileName": "src/lib/fetch.ts", "line": 2, "character": 0 } ] }, { "id": 53, "name": "lib/helpers", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 59, "name": "applySettingDefaults", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/helpers.ts", "line": 18, "character": 16 } ], "signatures": [ { "id": 60, "name": "applySettingDefaults", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 61, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 62, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 61, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 61, "name": "Database" } } ] } } } ], "parameters": [ { "id": 63, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 70, "typeArguments": [ { "type": "reference", "id": 62, "name": "SchemaName" } ], "name": "SupabaseClientOptions", "dereferenced": { "id": 70, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 12 } ], "typeParameter": [ { "id": 90, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reflection", "declaration": { "id": 71, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 75, "name": "auth", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 77, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 23, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 83, "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 47, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "debug" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 80, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 35, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 82, "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "flowType" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 53, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "lock" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 79, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged-in session to storage. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 31, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 81, "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged-in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 39, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "storage" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 78, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional key name used for storing tokens in local storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 27, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [77, 83, 80, 82, 84, 79, 81, 78] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 9 } ] } } }, { "id": 72, "name": "db", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 73, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 74, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 4 } ], "type": { "type": "reference", "id": 90, "name": "SchemaName", "dereferenced": {} } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [74] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 7 } ] } } }, { "id": 86, "name": "global", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 88, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 4 } ], "type": { "type": "reference", "id": 69, "name": "Fetch", "dereferenced": { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 12 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 28, "qualifiedName": "fetch", "package": "typescript", "name": "fetch" } } } } }, { "id": 89, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [88, 89] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 11 } ] } } }, { "id": 85, "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": 58, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClientOptions", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 48 } ] } } } } }, { "id": 64, "name": "defaults", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 70, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "SupabaseClientOptions", "dereferenced": { "id": 70, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 12 } ], "typeParameter": [ { "id": 90, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reflection", "declaration": { "id": 71, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 75, "name": "auth", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 77, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 23, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 83, "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 47, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "debug" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 80, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 35, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 82, "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "flowType" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 53, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "lock" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 79, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged-in session to storage. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 31, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 81, "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged-in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 39, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "storage" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 78, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional key name used for storing tokens in local storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 27, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [77, 83, 80, 82, 84, 79, 81, 78] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 9 } ] } } }, { "id": 72, "name": "db", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 73, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 74, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 4 } ], "type": { "type": "reference", "id": 90, "name": "SchemaName", "dereferenced": {} } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [74] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 7 } ] } } }, { "id": 86, "name": "global", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 88, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 4 } ], "type": { "type": "reference", "id": 69, "name": "Fetch", "dereferenced": { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 12 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 28, "qualifiedName": "fetch", "package": "typescript", "name": "fetch" } } } } }, { "id": 89, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [88, 89] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 11 } ] } } }, { "id": 85, "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": 58, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClientOptions", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 48 } ] } } } } } ], "type": { "type": "reference", "id": 70, "typeArguments": [ { "type": "reference", "id": 62, "name": "SchemaName" } ], "name": "SupabaseClientOptions" } } ] }, { "id": 65, "name": "isBrowser", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/helpers.ts", "line": 16, "character": 13 } ], "signatures": [ { "id": 66, "name": "isBrowser", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 56, "name": "stripTrailingSlash", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/helpers.ts", "line": 12, "character": 16 } ], "signatures": [ { "id": 57, "name": "stripTrailingSlash", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 58, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 54, "name": "uuid", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/helpers.ts", "line": 4, "character": 16 } ], "signatures": [ { "id": 55, "name": "uuid", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] } ], "groups": [ { "title": "Functions", "kind": 64, "children": [59, 65, 56, 54] } ], "sources": [ { "fileName": "src/lib/helpers.ts", "line": 2, "character": 0 } ] }, { "id": 67, "name": "lib/types", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 68, "name": "SupabaseAuthClientOptions", "kind": 256, "kindString": "Interface", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 7, "character": 17 } ], "extendedTypes": [ { "type": "reference", "name": "AuthClientOptions" } ] }, { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 12 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 28, "qualifiedName": "fetch", "package": "typescript", "name": "fetch" } } }, { "id": 101, "name": "GenericFunction", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 85, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 103, "name": "Args", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 86, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 104, "name": "Returns", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 87, "character": 2 } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 85, "character": 30 } ] } } }, { "id": 97, "name": "GenericNonUpdatableView", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 79, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 99, "name": "Row", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [99] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 79, "character": 38 } ] } } }, { "id": 105, "name": "GenericSchema", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 90, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 109, "name": "Functions", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 93, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "id": 101, "name": "GenericFunction" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 107, "name": "Tables", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 91, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "id": 91, "name": "GenericTable" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 108, "name": "Views", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "id": 100, "name": "GenericView" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [109, 107, 108] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 90, "character": 28 } ] } } }, { "id": 91, "name": "GenericTable", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 71, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 92, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 94, "name": "Insert", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 73, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 93, "name": "Row", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 72, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 95, "name": "Update", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [94, 93, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 71, "character": 27 } ] } } }, { "id": 96, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 77, "character": 12 } ], "type": { "type": "reference", "id": 91, "name": "GenericTable" } }, { "id": 100, "name": "GenericView", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 83, "character": 12 } ], "type": { "type": "union", "types": [ { "id": 96, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 77, "character": 12 } ], "type": { "type": "reference", "id": 91, "name": "GenericTable" } }, { "id": 97, "name": "GenericNonUpdatableView", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 79, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 99, "name": "Row", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [99] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 79, "character": 38 } ] } } } ] } }, { "id": 112, "name": "QueryData", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 100, "character": 12 } ], "typeParameter": [ { "id": 115, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "conditional", "checkType": { "type": "reference", "id": 115, "name": "T" }, "extendsType": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 114, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 100, "character": 51 } ], "type": { "type": "inferred", "name": "U" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [114] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 100, "character": 49 } ] } } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "trueType": { "type": "reference", "typeArguments": [ { "type": "reference", "name": "U" }, { "type": "literal", "value": null } ], "qualifiedName": "Exclude", "package": "typescript", "name": "Exclude" }, "falseType": { "type": "intrinsic", "name": "never" } } }, { "id": 116, "name": "QueryError", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 101, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "PostgrestError", "package": "@supabase/postgrest-js", "name": "PostgrestError" } }, { "id": 110, "name": "QueryResult", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "Helper types for query results." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 99, "character": 12 } ], "typeParameter": [ { "id": 111, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "conditional", "checkType": { "type": "reference", "id": 111, "name": "T" }, "extendsType": { "type": "reference", "typeArguments": [ { "type": "inferred", "name": "U" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "trueType": { "type": "reference", "name": "U" }, "falseType": { "type": "intrinsic", "name": "never" } } }, { "id": 70, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 12 } ], "typeParameter": [ { "id": 90, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reflection", "declaration": { "id": 71, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 75, "name": "auth", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 77, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 23, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 83, "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 47, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "debug" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 80, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 35, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 82, "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 43, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "flowType" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 84, "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 53, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "lock" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 79, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Whether to persist a logged-in session to storage. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 31, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 81, "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A storage provider. Used to store the logged-in session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 39, "character": 4 } ], "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "storage" }, "objectType": { "type": "reference", "id": 68, "name": "SupabaseAuthClientOptions" } } }, { "id": 78, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional key name used for storing tokens in local storage." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 27, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [77, 83, 80, 82, 84, 79, 81, 78] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 9 } ] } } }, { "id": 72, "name": "db", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 73, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 74, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 4 } ], "type": { "type": "reference", "id": 90, "name": "SchemaName", "dereferenced": {} } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [74] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 7 } ] } } }, { "id": 86, "name": "global", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 88, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom `fetch` implementation." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 63, "character": 4 } ], "type": { "type": "reference", "id": 69, "name": "Fetch", "dereferenced": { "id": 69, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 12 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 28, "qualifiedName": "fetch", "package": "typescript", "name": "fetch" } } } } }, { "id": 89, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Optional headers for initializing the client." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [88, 89] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 59, "character": 11 } ] } } }, { "id": 85, "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": 58, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "RealtimeClientOptions", "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 11, "character": 48 } ] } } } ], "groups": [ { "title": "Interfaces", "kind": 256, "children": [68] }, { "title": "Type Aliases", "kind": 4194304, "children": [69, 101, 97, 105, 91, 96, 100, 112, 116, 110, 70] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 0 } ] }, { "id": 117, "name": "lib/version", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 118, "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": [118] } ], "sources": [ { "fileName": "src/lib/version.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 2, "children": [1, 10, 24, 53, 67, 117] } ] }, { "id": 0, "name": "@supabase/auth-js", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 1065, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1066, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 21, "character": 2 } ], "signatures": [ { "id": 1067, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1068, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1069, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "id": 1065, "name": "AuthApiError" }, "overwrites": { "type": "reference", "id": 1060, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1059, "name": "AuthError.constructor" } }, { "id": 1070, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 19, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "id": 1063, "name": "AuthError.status" } }, { "id": 1071, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 27, "character": 2 } ], "signatures": [ { "id": 1072, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1073, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1075, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 30, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1074, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 29, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1076, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 31, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1075, 1074, 1076] } ] } } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1066] }, { "title": "Properties", "kind": 1024, "children": [1070] }, { "title": "Methods", "kind": 2048, "children": [1071] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 18, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1058, "name": "AuthError" } ] }, { "id": 1058, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1059, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 7, "character": 2 } ], "signatures": [ { "id": 1060, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1061, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1062, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" }, "overwrites": { "type": "reference", "name": "Error.constructor" } } ], "overwrites": { "type": "reference", "name": "Error.constructor" } }, { "id": 1063, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 4, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1059] }, { "title": "Properties", "kind": 1024, "children": [1063] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 3, "character": 13 } ], "extendedTypes": [ { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } ], "extendedBy": [ { "type": "reference", "id": 1065, "name": "AuthApiError" }, { "type": "reference", "id": 1078, "name": "AuthUnknownError" }, { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1138, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1139, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 88, "character": 2 } ], "signatures": [ { "id": 1140, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1141, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1142, "name": "details", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1145, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 88, "character": 57 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1144, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 88, "character": 42 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1145, 1144] } ] } } ] }, "defaultValue": "null" } ], "type": { "type": "reference", "id": 1138, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", "id": 1088, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1087, "name": "CustomAuthError.constructor" } }, { "id": 1146, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 87, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1147, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1149, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 87, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1148, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 87, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1149, 1148] } ] } } ] }, "defaultValue": "null" }, { "id": 1160, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 1092, "name": "CustomAuthError.name" } }, { "id": 1161, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 1093, "name": "CustomAuthError.status" } }, { "id": 1150, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 93, "character": 2 } ], "signatures": [ { "id": 1151, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1156, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 98, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1157, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1159, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 87, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1158, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 87, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1159, 1158] } ] } } ] }, "defaultValue": "..." }, { "id": 1154, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 96, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1153, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 95, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1155, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 97, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1156, 1154, 1153, 1155] } ] } }, "overwrites": { "type": "reference", "id": 1095, "name": "CustomAuthError.toJSON" } } ], "overwrites": { "type": "reference", "id": 1094, "name": "CustomAuthError.toJSON" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1139] }, { "title": "Properties", "kind": 1024, "children": [1146, 1160, 1161] }, { "title": "Methods", "kind": 2048, "children": [1150] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 86, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1125, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1126, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 81, "character": 2 } ], "signatures": [ { "id": 1127, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1128, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 1125, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", "id": 1088, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1087, "name": "CustomAuthError.constructor" } }, { "id": 1129, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 1092, "name": "CustomAuthError.name" } }, { "id": 1130, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 1093, "name": "CustomAuthError.status" } }, { "id": 1131, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 1132, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1135, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 62, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1134, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 61, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1136, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 63, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1135, 1134, 1136] } ] } }, "inheritedFrom": { "type": "reference", "id": 1095, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", "id": 1094, "name": "CustomAuthError.toJSON" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1126] }, { "title": "Properties", "kind": 1024, "children": [1129, 1130] }, { "title": "Methods", "kind": 2048, "children": [1131] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 80, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1113, "name": "AuthInvalidTokenResponseError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1114, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 75, "character": 2 } ], "signatures": [ { "id": 1115, "name": "new AuthInvalidTokenResponseError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", "id": 1113, "name": "AuthInvalidTokenResponseError" }, "overwrites": { "type": "reference", "id": 1088, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1087, "name": "CustomAuthError.constructor" } }, { "id": 1116, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 1092, "name": "CustomAuthError.name" } }, { "id": 1117, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 1093, "name": "CustomAuthError.status" } }, { "id": 1118, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 1119, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1120, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1122, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 62, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1121, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 61, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1123, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 63, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1122, 1121, 1123] } ] } }, "inheritedFrom": { "type": "reference", "id": 1095, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", "id": 1094, "name": "CustomAuthError.toJSON" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1114] }, { "title": "Properties", "kind": 1024, "children": [1116, 1117] }, { "title": "Methods", "kind": 2048, "children": [1118] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 74, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1163, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1164, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 105, "character": 2 } ], "signatures": [ { "id": 1165, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1166, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1167, "name": "details", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1170, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 105, "character": 57 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1169, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 105, "character": 42 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1170, 1169] } ] } } ] }, "defaultValue": "null" } ], "type": { "type": "reference", "id": 1163, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", "id": 1088, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1087, "name": "CustomAuthError.constructor" } }, { "id": 1171, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 104, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1174, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 104, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1173, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 104, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1174, 1173] } ] } } ] }, "defaultValue": "null" }, { "id": 1185, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 1092, "name": "CustomAuthError.name" } }, { "id": 1186, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 1093, "name": "CustomAuthError.status" } }, { "id": 1175, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 110, "character": 2 } ], "signatures": [ { "id": 1176, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1177, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1181, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 115, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1184, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 104, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1183, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 104, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1184, 1183] } ] } } ] }, "defaultValue": "..." }, { "id": 1179, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 113, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1178, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 112, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1180, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 114, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1181, 1179, 1178, 1180] } ] } }, "overwrites": { "type": "reference", "id": 1095, "name": "CustomAuthError.toJSON" } } ], "overwrites": { "type": "reference", "id": 1094, "name": "CustomAuthError.toJSON" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1164] }, { "title": "Properties", "kind": 1024, "children": [1171, 1185, 1186] }, { "title": "Methods", "kind": 2048, "children": [1175] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 103, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1188, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1189, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 121, "character": 2 } ], "signatures": [ { "id": 1190, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1191, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1192, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "id": 1188, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", "id": 1088, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1087, "name": "CustomAuthError.constructor" } }, { "id": 1193, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 1092, "name": "CustomAuthError.name" } }, { "id": 1194, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 1093, "name": "CustomAuthError.status" } }, { "id": 1195, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 1196, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1199, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 62, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1198, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 61, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1200, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 63, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1199, 1198, 1200] } ] } }, "inheritedFrom": { "type": "reference", "id": 1095, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", "id": 1094, "name": "CustomAuthError.toJSON" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1189] }, { "title": "Properties", "kind": 1024, "children": [1193, 1194] }, { "title": "Methods", "kind": 2048, "children": [1195] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 120, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1101, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1102, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 69, "character": 2 } ], "signatures": [ { "id": 1103, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", "id": 1101, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", "id": 1088, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1087, "name": "CustomAuthError.constructor" } }, { "id": 1104, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 1092, "name": "CustomAuthError.name" } }, { "id": 1105, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 1093, "name": "CustomAuthError.status" } }, { "id": 1106, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 1107, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1110, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 62, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1109, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 61, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1111, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 63, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1110, 1109, 1111] } ] } }, "inheritedFrom": { "type": "reference", "id": 1095, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", "id": 1094, "name": "CustomAuthError.toJSON" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1102] }, { "title": "Properties", "kind": 1024, "children": [1104, 1105] }, { "title": "Methods", "kind": 2048, "children": [1106] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 68, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1078, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1079, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 43, "character": 2 } ], "signatures": [ { "id": 1080, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1081, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1082, "name": "originalError", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 1078, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", "id": 1060, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1059, "name": "AuthError.constructor" } }, { "id": 1083, "name": "originalError", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 41, "character": 2 } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 1084, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 4, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] }, "inheritedFrom": { "type": "reference", "id": 1063, "name": "AuthError.status" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1079] }, { "title": "Properties", "kind": 1024, "children": [1083, 1084] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 40, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1058, "name": "AuthError" } ] }, { "id": 1202, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate." }, "children": [ { "id": 1203, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 141, "character": 2 } ], "signatures": [ { "id": 1204, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1205, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1206, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1207, "name": "reasons", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "reference", "id": 1202, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", "id": 1088, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1087, "name": "CustomAuthError.constructor" } }, { "id": 1209, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 1092, "name": "CustomAuthError.name" } }, { "id": 1208, "name": "reasons", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Reasons why the password is deemed weak." }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 139, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1210, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 1093, "name": "CustomAuthError.status" } }, { "id": 1211, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 1212, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1213, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1215, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 62, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1214, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 61, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1216, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 63, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1215, 1214, 1216] } ] } }, "inheritedFrom": { "type": "reference", "id": 1095, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", "id": 1094, "name": "CustomAuthError.toJSON" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1203] }, { "title": "Properties", "kind": 1024, "children": [1209, 1208, 1210] }, { "title": "Methods", "kind": 2048, "children": [1211] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 135, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1086, "name": "CustomAuthError" } ] }, { "id": 1086, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 1087, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 53, "character": 2 } ], "signatures": [ { "id": 1088, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 1089, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1090, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1091, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "id": 1086, "name": "CustomAuthError" }, "overwrites": { "type": "reference", "id": 1060, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", "id": 1059, "name": "AuthError.constructor" } }, { "id": 1092, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 51, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "name": "AuthError.name" } }, { "id": 1093, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "id": 1063, "name": "AuthError.status" } }, { "id": 1094, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 1095, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1096, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1098, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 62, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1097, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 61, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1099, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 63, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1098, 1097, 1099] } ] } } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [1087] }, { "title": "Properties", "kind": 1024, "children": [1092, 1093] }, { "title": "Methods", "kind": 2048, "children": [1094] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 50, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 1058, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", "id": 1101, "name": "AuthSessionMissingError" }, { "type": "reference", "id": 1113, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", "id": 1125, "name": "AuthInvalidCredentialsError" }, { "type": "reference", "id": 1138, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", "id": 1163, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", "id": 1188, "name": "AuthRetryableFetchError" }, { "type": "reference", "id": 1202, "name": "AuthWeakPasswordError" } ] }, { "id": 1, "name": "GoTrueAdminApi", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 2, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 35, "character": 2 } ], "signatures": [ { "id": 3, "name": "new GoTrueAdminApi", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 4, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 5, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 11, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 44, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 12, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 13, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 14, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 15, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 7, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 41, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 8, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 9, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 10, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 6, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 40, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [11, 7, 6] } ] } } } ], "type": { "type": "reference", "id": 1, "name": "default" } } ] }, { "id": 16, "name": "mfa", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Contains all MFA administration methods." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "id": 1012, "name": "GoTrueAdminMFAApi", "dereferenced": { "id": 1012, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "Contains the full multi-factor authentication administration API.", "tags": [ { "tag": "expermental", "text": "\n" } ] }, "children": [ { "id": 1016, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1017, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#unenroll}\n" }, { "tag": "expermental", "text": "\n" } ] }, "parameters": [ { "id": 1018, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 996, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { "id": 996, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 997, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 998, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the MFA factor to delete." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1030, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 999, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user whose factor is being deleted." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1033, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [998, 999] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 45 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 987, "name": "AuthMFAAdminDeleteFactorResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Lists all factors associated to a user." }, "parameters": [ { "id": 1015, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 1009, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { "id": 1009, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1010, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1011, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1054, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1011] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 44 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 1000, "name": "AuthMFAAdminListFactorsResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [1016, 1013] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1062, "character": 17 } ] } } }, { "id": 44, "name": "createUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 152, "character": 8 } ], "signatures": [ { "id": 45, "name": "createUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." }, "parameters": [ { "id": 46, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 685, "name": "AdminUserAttributes", "dereferenced": { "id": 685, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 687, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 398, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 690, "name": "ban_duration", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Determines how long a user is banned for.", "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 424, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 694, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 349, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.email" } }, { "id": 688, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 405, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 693, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", "text": "Call reauthenticate() to obtain the nonce first.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 366, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.nonce" } }, { "id": 692, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 359, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.password" } }, { "id": 695, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 354, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.phone" } }, { "id": 689, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 412, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 691, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The `role` claim set in the user's access token JWT.", "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 433, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 686, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 388, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 377, "character": 17 } ], "extendedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 679, "name": "UserAttributes" }, { "type": "literal", "value": "data" } ], "qualifiedName": "Omit", "package": "typescript", "name": "Omit" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 68, "name": "deleteUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 268, "character": 8 } ], "signatures": [ { "id": 69, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Delete a user. Requires a `service_role` key." }, "parameters": [ { "id": 70, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user id you want to remove." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 71, "name": "shouldSoftDelete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 41, "name": "generateLink", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 118, "character": 8 } ], "signatures": [ { "id": 42, "name": "generateLink", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates email links and OTPs to be sent via a custom email provider." }, "parameters": [ { "id": 43, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 855, "name": "GenerateLinkParams", "dereferenced": { "id": 855, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 733, "character": 12 } ], "type": { "type": "union", "types": [ { "id": 830, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 831, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 833, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 835, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 694, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 834, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 693, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 832, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 691, "character": 2 } ], "type": { "type": "literal", "value": "signup" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [833, 835, 834, 832] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 39 } ] } } }, { "id": 836, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 839, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 700, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 840, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 701, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 838, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 698, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [839, 840, 838] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 46 } ] } } }, { "id": 841, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 844, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 707, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 845, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 708, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 843, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 705, "character": 2 } ], "type": { "type": "literal", "value": "recovery" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [844, 845, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 41 } ] } } }, { "id": 846, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 849, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 714, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 850, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 718, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 851, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 719, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 848, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 712, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [849, 850, 851, 848] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 44 } ] } } } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 856, "name": "GenerateLinkResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 61, "name": "getUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 62, "name": "getUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get user by id." }, "parameters": [ { "id": 63, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 34, "name": "inviteUserByEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 85, "character": 8 } ], "signatures": [ { "id": 35, "name": "inviteUserByEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends an invite link to an email address." }, "parameters": [ { "id": 36, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 37, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Additional options to be included when inviting.\n" }, "type": { "type": "reflection", "declaration": { "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 39, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 89, "character": 6 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 40, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 92, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [39, 40] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 47, "name": "listUsers", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 174, "character": 8 } ], "signatures": [ { "id": 48, "name": "listUsers", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get a list of users.", "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." }, "parameters": [ { "id": 49, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n" }, "type": { "type": "reference", "id": 1039, "name": "PageParams", "dereferenced": { "id": 1039, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1121, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1041, "name": "page", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The page number" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1123, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1042, "name": "perPage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Number of items returned per page" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1041, 1042] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1121, "character": 25 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 50, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 51, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 8 } ], "type": { "type": "intersection", "types": [ { "type": "reflection", "declaration": { "id": 52, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 54, "name": "aud", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 31 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 53, "name": "users", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 16 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 656, "name": "User" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [54, 53] } ] } }, { "type": "reference", "id": 1032, "name": "Pagination" } ] } }, { "id": 55, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 59 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [51, 55] } ] } }, { "type": "reflection", "declaration": { "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 57, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 178, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 58, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 59, "name": "users", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 178, "character": 16 } ], "type": { "type": "tuple" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [59] } ] } } }, { "id": 60, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 178, "character": 29 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [57, 60] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 27, "name": "signOut", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 60, "character": 8 } ], "signatures": [ { "id": 28, "name": "signOut", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Removes a logged-in session." }, "parameters": [ { "id": 29, "name": "jwt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A valid, logged-in JWT." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 30, "name": "scope", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The logout sope.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": "global" }, { "type": "literal", "value": "local" }, { "type": "literal", "value": "others" } ] }, "defaultValue": "'global'" } ], "type": { "type": "reference", "typeArguments": [ { "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/GoTrueAdminApi.ts", "line": 63, "character": 15 } ], "type": { "type": "literal", "value": null } }, { "id": 33, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 63, "character": 27 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 1058, "name": "AuthError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [32, 33] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 64, "name": "updateUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 243, "character": 8 } ], "signatures": [ { "id": 65, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates the user data." }, "parameters": [ { "id": 66, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 67, "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": 685, "name": "AdminUserAttributes", "dereferenced": { "id": 685, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 687, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 398, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 690, "name": "ban_duration", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Determines how long a user is banned for.", "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 424, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 694, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 349, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.email" } }, { "id": 688, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 405, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 693, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", "text": "Call reauthenticate() to obtain the nonce first.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 366, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.nonce" } }, { "id": 692, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 359, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.password" } }, { "id": 695, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 354, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.phone" } }, { "id": 689, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 412, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 691, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The `role` claim set in the user's access token JWT.", "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 433, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 686, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 388, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 377, "character": 17 } ], "extendedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 679, "name": "UserAttributes" }, { "type": "literal", "value": "data" } ], "qualifiedName": "Omit", "package": "typescript", "name": "Omit" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [2] }, { "title": "Properties", "kind": 1024, "children": [16] }, { "title": "Methods", "kind": 2048, "children": [44, 68, 41, 61, 34, 47, 27, 64] } ], "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 25, "character": 21 } ] }, { "id": 78, "name": "GoTrueClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 80, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 175, "character": 2 } ], "signatures": [ { "id": 81, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Create a new client for use in the browser." }, "parameters": [ { "id": 82, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 490, "name": "GoTrueClientOptions", "dereferenced": { "id": 490, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 491, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 499, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 66, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 504, "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 76, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 76, "character": 21 } ], "signatures": [ { "id": 506, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 507, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 508, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } ] } }, { "id": 498, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 502, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 72, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 503, "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, "character": 2 } ], "type": { "type": "reference", "id": 759, "name": "AuthFlowType", "dereferenced": { "id": 759, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 565, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "implicit" }, { "type": "literal", "value": "pkce" } ] } } } }, { "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 494, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 12 } ], "indexSignature": { "id": 495, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 496, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 509, "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "LockFunc", "dereferenced": { "id": 481, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 482, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 23 } ], "signatures": [ { "id": 483, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "typeParameter": [ { "id": 489, "name": "R", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 484, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Name of the lock to be acquired." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 485, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 486, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operation to execute when the lock is acquired.\n" }, "type": { "type": "reflection", "declaration": { "id": 487, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 69 } ], "signatures": [ { "id": 488, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 489, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 489, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } } }, { "id": 500, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 501, "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 70, "character": 2 } ], "type": { "type": "reference", "id": 1019, "name": "SupportedStorage", "dereferenced": { "id": 1019, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1089, "character": 12 } ], "type": { "type": "intersection", "types": [ { "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" }, { "type": "reflection", "declaration": { "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1021, "name": "isServer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1099, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1021] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1091, "character": 4 } ] } } ] } } } }, { "id": 497, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 62, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 492, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 58, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 499, 504, 498, 502, 503, 493, 509, 500, 501, 497, 492 ] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 56, "character": 34 } ] } } } } } ], "type": { "type": "reference", "id": 78, "name": "default" } } ] }, { "id": 84, "name": "admin", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 125, "character": 2 } ], "type": { "type": "reference", "id": 1, "name": "default", "dereferenced": { "id": 1, "name": "GoTrueAdminApi", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 2, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 35, "character": 2 } ], "signatures": [ { "id": 3, "name": "new GoTrueAdminApi", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 4, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 5, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 11, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 44, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 12, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 13, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 14, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 15, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 7, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 41, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 8, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 9, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 10, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 6, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 40, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [11, 7, 6] } ] } } } ], "type": { "type": "reference", "id": 1, "name": "default" } } ] }, { "id": 16, "name": "mfa", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Contains all MFA administration methods." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "id": 1012, "name": "GoTrueAdminMFAApi", "dereferenced": { "id": 1012, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "Contains the full multi-factor authentication administration API.", "tags": [ { "tag": "expermental", "text": "\n" } ] }, "children": [ { "id": 1016, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1017, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#unenroll}\n" }, { "tag": "expermental", "text": "\n" } ] }, "parameters": [ { "id": 1018, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 996, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { "id": 996, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 997, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 998, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the MFA factor to delete." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1030, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 999, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user whose factor is being deleted." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1033, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [998, 999] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 45 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 987, "name": "AuthMFAAdminDeleteFactorResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Lists all factors associated to a user." }, "parameters": [ { "id": 1015, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 1009, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { "id": 1009, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1010, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1011, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1054, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1011] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 44 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 1000, "name": "AuthMFAAdminListFactorsResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [1016, 1013] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1062, "character": 17 } ] } } }, { "id": 44, "name": "createUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 152, "character": 8 } ], "signatures": [ { "id": 45, "name": "createUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." }, "parameters": [ { "id": 46, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 685, "name": "AdminUserAttributes", "dereferenced": { "id": 685, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 687, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 398, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 690, "name": "ban_duration", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Determines how long a user is banned for.", "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 424, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 694, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 349, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.email" } }, { "id": 688, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 405, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 693, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", "text": "Call reauthenticate() to obtain the nonce first.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 366, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.nonce" } }, { "id": 692, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 359, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.password" } }, { "id": 695, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 354, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.phone" } }, { "id": 689, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 412, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 691, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The `role` claim set in the user's access token JWT.", "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 433, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 686, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 388, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 377, "character": 17 } ], "extendedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 679, "name": "UserAttributes" }, { "type": "literal", "value": "data" } ], "qualifiedName": "Omit", "package": "typescript", "name": "Omit" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 68, "name": "deleteUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 268, "character": 8 } ], "signatures": [ { "id": 69, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Delete a user. Requires a `service_role` key." }, "parameters": [ { "id": 70, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user id you want to remove." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 71, "name": "shouldSoftDelete", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 41, "name": "generateLink", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 118, "character": 8 } ], "signatures": [ { "id": 42, "name": "generateLink", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Generates email links and OTPs to be sent via a custom email provider." }, "parameters": [ { "id": 43, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 855, "name": "GenerateLinkParams", "dereferenced": { "id": 855, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 733, "character": 12 } ], "type": { "type": "union", "types": [ { "id": 830, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 831, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 833, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 835, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 694, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 834, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 693, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 832, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 691, "character": 2 } ], "type": { "type": "literal", "value": "signup" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [833, 835, 834, 832] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 39 } ] } } }, { "id": 836, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 839, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 700, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 840, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 701, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 838, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 698, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [839, 840, 838] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 46 } ] } } }, { "id": 841, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 844, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 707, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 845, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 708, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 843, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 705, "character": 2 } ], "type": { "type": "literal", "value": "recovery" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [844, 845, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 41 } ] } } }, { "id": 846, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 849, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 714, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 850, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 718, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 851, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 719, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 848, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 712, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [849, 850, 851, 848] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 44 } ] } } } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 856, "name": "GenerateLinkResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 61, "name": "getUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 62, "name": "getUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get user by id." }, "parameters": [ { "id": 63, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 34, "name": "inviteUserByEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 85, "character": 8 } ], "signatures": [ { "id": 35, "name": "inviteUserByEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends an invite link to an email address." }, "parameters": [ { "id": 36, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 37, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Additional options to be included when inviting.\n" }, "type": { "type": "reflection", "declaration": { "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 39, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 89, "character": 6 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 40, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 92, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [39, 40] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 47, "name": "listUsers", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 174, "character": 8 } ], "signatures": [ { "id": 48, "name": "listUsers", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Get a list of users.", "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." }, "parameters": [ { "id": 49, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n" }, "type": { "type": "reference", "id": 1039, "name": "PageParams", "dereferenced": { "id": 1039, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1121, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1041, "name": "page", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The page number" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1123, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1042, "name": "perPage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Number of items returned per page" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1041, 1042] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1121, "character": 25 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 50, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 51, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 8 } ], "type": { "type": "intersection", "types": [ { "type": "reflection", "declaration": { "id": 52, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 54, "name": "aud", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 31 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 53, "name": "users", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 16 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 656, "name": "User" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [54, 53] } ] } }, { "type": "reference", "id": 1032, "name": "Pagination" } ] } }, { "id": 55, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 177, "character": 59 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [51, 55] } ] } }, { "type": "reflection", "declaration": { "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 57, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 178, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 58, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 59, "name": "users", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 178, "character": 16 } ], "type": { "type": "tuple" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [59] } ] } } }, { "id": 60, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 178, "character": 29 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [57, 60] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 27, "name": "signOut", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 60, "character": 8 } ], "signatures": [ { "id": 28, "name": "signOut", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Removes a logged-in session." }, "parameters": [ { "id": 29, "name": "jwt", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A valid, logged-in JWT." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 30, "name": "scope", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The logout sope.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": "global" }, { "type": "literal", "value": "local" }, { "type": "literal", "value": "others" } ] }, "defaultValue": "'global'" } ], "type": { "type": "reference", "typeArguments": [ { "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/GoTrueAdminApi.ts", "line": 63, "character": 15 } ], "type": { "type": "literal", "value": null } }, { "id": 33, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 63, "character": 27 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 1058, "name": "AuthError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [32, 33] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 64, "name": "updateUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 243, "character": 8 } ], "signatures": [ { "id": 65, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates the user data." }, "parameters": [ { "id": 66, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 67, "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": 685, "name": "AdminUserAttributes", "dereferenced": { "id": 685, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 687, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 398, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 690, "name": "ban_duration", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Determines how long a user is banned for.", "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 424, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 694, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 349, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.email" } }, { "id": 688, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 405, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 693, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", "text": "Call reauthenticate() to obtain the nonce first.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 366, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.nonce" } }, { "id": 692, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 359, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.password" } }, { "id": 695, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 354, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.phone" } }, { "id": 689, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 412, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 691, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The `role` claim set in the user's access token JWT.", "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 433, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 686, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 388, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 377, "character": 17 } ], "extendedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 679, "name": "UserAttributes" }, { "type": "literal", "value": "data" } ], "qualifiedName": "Omit", "package": "typescript", "name": "Omit" } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [2] }, { "title": "Properties", "kind": 1024, "children": [16] }, { "title": "Methods", "kind": 2048, "children": [44, 68, 41, 61, 34, 47, 27, 64] } ], "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 25, "character": 21 } ] } } }, { "id": 85, "name": "mfa", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Namespace for the MFA methods." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 129, "character": 2 } ], "type": { "type": "reference", "id": 967, "name": "GoTrueMFAApi", "dereferenced": { "id": 967, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "Contains the full multi-factor authentication API." }, "children": [ { "id": 971, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 972, "name": "challenge", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." }, "parameters": [ { "id": 973, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 890, "name": "MFAChallengeParams", "dereferenced": { "id": 890, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 810, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 892, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor to be challenged. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 812, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [892] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 810, "character": 33 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 935, "name": "AuthMFAChallengeResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 980, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 981, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." }, "parameters": [ { "id": 982, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 893, "name": "MFAChallengeAndVerifyParams", "dereferenced": { "id": 893, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 815, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 894, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 896, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Verification code provided by the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 819, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 895, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 817, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [896, 895] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 815, "character": 42 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 897, "name": "AuthMFAVerifyResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 968, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 969, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" }, "parameters": [ { "id": 970, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 877, "name": "MFAEnrollParams", "dereferenced": { "id": 877, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 878, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 879, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of factor being enrolled." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 787, "character": 2 } ], "type": { "type": "literal", "value": "totp" } }, { "id": 881, "name": "friendlyName", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Human readable name assigned to the factor." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 791, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 880, "name": "issuer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Domain which the user is enrolled with." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 789, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [879, 881, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 785, "character": 30 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 910, "name": "AuthMFAEnrollResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 985, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 986, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 956, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 983, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 984, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the list of MFA factors enabled for this user.", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#enroll}" }, { "tag": "see", "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" }, { "tag": "see", "text": "{@link GoTrueClient#getUser}\n\n" } ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 945, "name": "AuthMFAListFactorsResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 977, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 978, "name": "unenroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." }, "parameters": [ { "id": 979, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 882, "name": "MFAUnenrollParams", "dereferenced": { "id": 882, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 794, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 883, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 884, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being unenrolled." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [884] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, "character": 32 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 926, "name": "AuthMFAUnenrollResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 974, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 975, "name": "verify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." }, "parameters": [ { "id": 976, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 885, "name": "MFAVerifyParams", "dereferenced": { "id": 885, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 799, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 888, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the challenge being verified. Returned in challenge()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 804, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 889, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Verification code provided by the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 887, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 801, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [888, 889, 887] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 799, "character": 30 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 897, "name": "AuthMFAVerifyResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [971, 980, 968, 985, 983, 977, 974] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 949, "character": 17 } ] } } }, { "id": 143, "name": "exchangeCodeForSession", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 571, "character": 8 } ], "signatures": [ { "id": 144, "name": "exchangeCodeForSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." }, "parameters": [ { "id": 145, "name": "authCode", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 557, "name": "AuthTokenResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 182, "name": "getSession", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 926, "character": 8 } ], "signatures": [ { "id": 183, "name": "getSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the session, refreshing it if necessary.", "text": "The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use {@link #getUser()} instead.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 184, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 185, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1028, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 186, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 187, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1029, "character": 14 } ], "type": { "type": "reference", "id": 618, "name": "Session" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [187] } ] } } }, { "id": 188, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1031, "character": 12 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [185, 188] } ] } }, { "type": "reflection", "declaration": { "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 190, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1034, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 191, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 192, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1035, "character": 14 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [192] } ] } } }, { "id": 193, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1037, "character": 12 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [190, 193] } ] } }, { "type": "reflection", "declaration": { "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 195, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1040, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 196, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 197, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1041, "character": 14 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [197] } ] } } }, { "id": 198, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1043, "character": 12 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [195, 198] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 245, "name": "getUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1166, "character": 8 } ], "signatures": [ { "id": 246, "name": "getUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." }, "parameters": [ { "id": 247, "name": "jwt", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 349, "name": "getUserIdentities", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1710, "character": 8 } ], "signatures": [ { "id": 350, "name": "getUserIdentities", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Gets all the identities linked to a user." }, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 352, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1712, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 353, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "identities", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1713, "character": 10 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 630, "name": "UserIdentity" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354] } ] } } }, { "id": 355, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1715, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [352, 355] } ] } }, { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1717, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 358, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1717, "character": 20 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357, 358] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 127, "name": "initialize", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 278, "character": 8 } ], "signatures": [ { "id": 128, "name": "initialize", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 1022, "name": "InitializeResult" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 359, "name": "linkIdentity", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1734, "character": 8 } ], "signatures": [ { "id": 360, "name": "linkIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." }, "parameters": [ { "id": 361, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 760, "name": "SignInWithOAuthCredentials", "dereferenced": { "id": 760, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 761, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 763, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 764, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 767, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An object of query params" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 575, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 768, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 575, "character": 18 } ], "indexSignature": { "id": 769, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 770, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 765, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 766, "name": "scopes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A space-separated list of scopes granted to the OAuth application." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 573, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 771, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [767, 765, 766, 771] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 569, "character": 12 } ] } } }, { "id": 762, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 568, "character": 2 } ], "type": { "type": "reference", "id": 478, "name": "Provider", "dereferenced": { "id": 478, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 5, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "bitbucket" }, { "type": "literal", "value": "discord" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "figma" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "kakao" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "linkedin_oidc" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "workos" }, { "type": "literal", "value": "zoom" }, { "type": "literal", "value": "fly" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [763, 762] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 566, "character": 41 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 585, "name": "OAuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 321, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1608, "character": 2 } ], "signatures": [ { "id": 322, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Receive a notification every time an auth event happens." }, "parameters": [ { "id": 323, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A callback function to be invoked when an auth event happens.\n" }, "type": { "type": "reflection", "declaration": { "id": 324, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 325, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 326, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 480, "name": "AuthChangeEvent" } }, { "id": 327, "name": "session", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 618, "name": "Session" } ] } } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "void" }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } ] } } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 328, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 329, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1611, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 330, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 331, "name": "subscription", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1611, "character": 12 } ], "type": { "type": "reference", "id": 696, "name": "Subscription", "dereferenced": { "id": 696, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 697, "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": 440, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 698, "name": "callback", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 444, "character": 2 } ], "signatures": [ { "id": 699, "name": "callback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The function to call every time there is an event. eg: (eventName) => {}" }, "parameters": [ { "id": 700, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 480, "name": "AuthChangeEvent", "dereferenced": { "id": 480, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 30, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INITIAL_SESSION" }, { "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" }, { "id": 479, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 12 } ], "type": { "type": "literal", "value": "MFA_CHALLENGE_VERIFIED" } } ] } } } }, { "id": 701, "name": "session", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 618, "name": "Session" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 702, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 448, "character": 2 } ], "signatures": [ { "id": 703, "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": [697] }, { "title": "Methods", "kind": 2048, "children": [698, 702] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 436, "character": 17 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [331] } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [329] } ] } } } ] }, { "id": 175, "name": "reauthenticate", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 838, "character": 8 } ], "signatures": [ { "id": 176, "name": "reauthenticate", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 515, "name": "AuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 282, "name": "refreshSession", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1374, "character": 8 } ], "signatures": [ { "id": 283, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." }, "parameters": [ { "id": 284, "name": "currentSession", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The current session. If passed in, it must contain a refresh token.\n" }, "type": { "type": "reflection", "declaration": { "id": 285, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 286, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1374, "character": 42 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [286] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 515, "name": "AuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 179, "name": "resend", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 873, "character": 8 } ], "signatures": [ { "id": 180, "name": "resend", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." }, "parameters": [ { "id": 181, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 803, "name": "ResendParams", "dereferenced": { "id": 803, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 804, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 806, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 807, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 650, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 808, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 654, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 809, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they have signed-in." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 652, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [810, 809] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 650, "character": 16 } ] } } }, { "id": 805, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 648, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 802, "name": "EmailOtpType" }, { "type": "union", "types": [ { "type": "literal", "value": "signup" }, { "type": "literal", "value": "email_change" } ] } ], "qualifiedName": "Extract", "package": "typescript", "name": "Extract" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [806, 807, 805] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 647, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 811, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 814, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 660, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 815, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 816, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 662, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [816] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 660, "character": 16 } ] } } }, { "id": 813, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 659, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 812, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 658, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 801, "name": "MobileOtpType" }, { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } ], "qualifiedName": "Extract", "package": "typescript", "name": "Extract" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [814, 813, 812] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 657, "character": 4 } ] } } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 542, "name": "AuthOtpResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 335, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1664, "character": 8 } ], "signatures": [ { "id": 336, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a password reset request to an email address. This method supports the PKCE flow." }, "parameters": [ { "id": 337, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 338, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 339, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 341, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site.\n" }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1668, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 340, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The URL to send the user to after they click the password reset link." }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1667, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [341, 340] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 342, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 343, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1672, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 344, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } }, { "id": 345, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1673, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [343, 345] } ] } }, { "type": "reflection", "declaration": { "id": 346, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 347, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1675, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 348, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1675, "character": 20 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [347, 348] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 270, "name": "setSession", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1299, "character": 8 } ], "signatures": [ { "id": 271, "name": "setSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." }, "parameters": [ { "id": 272, "name": "currentSession", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The current session that minimally contains an access token and refresh token.\n" }, "type": { "type": "reflection", "declaration": { "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 274, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1300, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 275, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1301, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [274, 275] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 515, "name": "AuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 131, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 368, "character": 8 } ], "signatures": [ { "id": 132, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new anonymous user.", "returns": "A session where the is_anonymous claim in the access token JWT set to true\n" }, "parameters": [ { "id": 133, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 706, "name": "SignInAnonymouslyCredentials", "dereferenced": { "id": 706, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 455, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 707, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 708, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 709, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 711, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 464, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 710, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 462, "character": 4 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [711, 710] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 456, "character": 12 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [708] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 455, "character": 43 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 515, "name": "AuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 163, "name": "signInWithIdToken", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 621, "character": 8 } ], "signatures": [ { "id": 164, "name": "signInWithIdToken", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." }, "parameters": [ { "id": 165, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 772, "name": "SignInWithIdTokenCredentials", "dereferenced": { "id": 772, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 581, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 773, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 776, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 587, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 777, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 589, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 778, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 590, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 779, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 780, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 592, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [780] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 590, "character": 12 } ] } } }, { "id": 774, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `keycloak` (deprecated)." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 583, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "google" }, { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "facebook" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 775, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 585, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [776, 777, 778, 774, 775] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 581, "character": 43 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 557, "name": "AuthTokenResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 140, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 557, "character": 8 } ], "signatures": [ { "id": 141, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." }, "parameters": [ { "id": 142, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 760, "name": "SignInWithOAuthCredentials", "dereferenced": { "id": 760, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 761, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 763, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 764, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 767, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An object of query params" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 575, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 768, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 575, "character": 18 } ], "indexSignature": { "id": 769, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 770, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 765, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 766, "name": "scopes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A space-separated list of scopes granted to the OAuth application." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 573, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 771, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [767, 765, 766, 771] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 569, "character": 12 } ] } } }, { "id": 762, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 568, "character": 2 } ], "type": { "type": "reference", "id": 478, "name": "Provider", "dereferenced": { "id": 478, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 5, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "bitbucket" }, { "type": "literal", "value": "discord" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "figma" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "kakao" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "linkedin_oidc" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "workos" }, { "type": "literal", "value": "zoom" }, { "type": "literal", "value": "fly" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [763, 762] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 566, "character": 41 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 585, "name": "OAuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 166, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 678, "character": 8 } ], "signatures": [ { "id": 167, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Log in a user using magiclink or a one-time password (OTP).", "text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed.\n" }, "parameters": [ { "id": 168, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 742, "name": "SignInWithPasswordlessCredentials", "dereferenced": { "id": 742, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 527, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 743, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 744, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 530, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 745, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 531, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 746, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 750, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 543, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 749, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 541, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 747, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The redirect url embedded in the email link" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 533, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 748, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to false, this method will not create a new user. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 535, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [750, 749, 747, 748] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 531, "character": 16 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [744, 745] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 528, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 751, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 753, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 549, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 757, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 559, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 758, "name": "channel", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Messaging channel to use (e.g. whatsapp or sms)" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 561, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "whatsapp" } ] } }, { "id": 756, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 557, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 755, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to false, this method will not create a new user. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 551, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [757, 758, 756, 755] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 549, "character": 16 } ] } } }, { "id": 752, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 548, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [753, 752] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 546, "character": 4 } ] } } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 542, "name": "AuthOtpResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 137, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 492, "character": 8 } ], "signatures": [ { "id": 138, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Log in an existing user with an email and password or phone and password.", "text": "Be aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login.\n" }, "parameters": [ { "id": 139, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 729, "name": "SignInWithPasswordCredentials", "dereferenced": { "id": 729, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 505, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 730, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 731, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 508, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 733, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 511, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 734, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 735, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 513, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [735] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 511, "character": 16 } ] } } }, { "id": 732, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 510, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [731, 733, 732] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 506, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 736, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 739, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 521, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 740, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 741, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 523, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [741] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 521, "character": 16 } ] } } }, { "id": 738, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 520, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 518, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [739, 738, 737] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 516, "character": 4 } ] } } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 570, "name": "AuthTokenResponsePassword" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 172, "name": "signInWithSSO", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 799, "character": 8 } ], "signatures": [ { "id": 173, "name": "signInWithSSO", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.", "text": "You can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead.\n" }, "parameters": [ { "id": 174, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 817, "name": "SignInWithSSO", "dereferenced": { "id": 817, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 666, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 818, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 820, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 671, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 823, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 675, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 822, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they have signed-in." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 673, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [823, 822] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 671, "character": 16 } ] } } }, { "id": 819, "name": "providerId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "UUID of the SSO provider to invoke single-sign on to." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 669, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [820, 819] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 667, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 824, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 825, "name": "domain", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Domain name of the organization for which to invoke single-sign on." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 680, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 826, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 682, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 827, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 829, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 686, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 828, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they have signed-in." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 684, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [829, 828] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 682, "character": 16 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [825, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 678, "character": 4 } ] } } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 598, "name": "SSOResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 311, "name": "signOut", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1568, "character": 8 } ], "signatures": [ { "id": 312, "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 and log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using `others` scope, no `SIGNED_OUT` event is fired!\n" }, "parameters": [ { "id": 313, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 1043, "name": "SignOut", "dereferenced": { "id": 1043, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1128, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1045, "name": "scope", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1139, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "global" }, { "type": "literal", "value": "local" }, { "type": "literal", "value": "others" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1128, "character": 22 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 314, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 315, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1568, "character": 67 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 1058, "name": "AuthError" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [315] } ] } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 134, "name": "signUp", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 413, "character": 8 } ], "signatures": [ { "id": 135, "name": "signUp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new user.", "text": "Be aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.\n", "returns": "A logged-in session if the server has \"autoconfirm\" ON" }, "parameters": [ { "id": 136, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 712, "name": "SignUpWithPasswordCredentials", "dereferenced": { "id": 712, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 468, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 713, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 714, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 471, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 716, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 474, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 717, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 720, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 484, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 719, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 482, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 718, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The redirect url embedded in the email link" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 476, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [720, 719, 718] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 474, "character": 16 } ] } } }, { "id": 715, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 473, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [714, 716, 715] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 469, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 721, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 724, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 492, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 725, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 727, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 500, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 728, "name": "channel", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Messaging channel to use (e.g. whatsapp or sms)" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 502, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "whatsapp" } ] } }, { "id": 726, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 498, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [727, 728, 726] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 492, "character": 16 } ] } } }, { "id": 723, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 491, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 722, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 489, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [724, 723, 722] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 487, "character": 4 } ] } } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 515, "name": "AuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 417, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2142, "character": 8 } ], "signatures": [ { "id": 418, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.", "text": "If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 419, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2155, "character": 8 } ], "signatures": [ { "id": 420, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Stops an active auto refresh process running in the background (if any).", "text": "If you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee {@link #startAutoRefresh} for more details.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 362, "name": "unlinkIdentity", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1770, "character": 8 } ], "signatures": [ { "id": 363, "name": "unlinkIdentity", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." }, "parameters": [ { "id": 364, "name": "identity", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 630, "name": "UserIdentity", "dereferenced": { "id": 630, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 639, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 279, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 631, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 272, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 633, "name": "identity_data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 274, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 634, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 635, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 636, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 637, "name": "identity_id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 277, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 640, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 280, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 638, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 278, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 641, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 281, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 632, "name": "user_id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 273, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [639, 631, 633, 637, 640, 638, 641, 632] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 271, "character": 17 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 366, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1772, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } }, { "id": 368, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1773, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [366, 368] } ] } }, { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 370, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1775, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 371, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1775, "character": 20 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [370, 371] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 251, "name": "updateUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1219, "character": 8 } ], "signatures": [ { "id": 252, "name": "updateUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates user data for a logged in user." }, "parameters": [ { "id": 253, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 679, "name": "UserAttributes", "dereferenced": { "id": 679, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 684, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 374, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 680, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 349, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 683, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", "text": "Call reauthenticate() to obtain the nonce first.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 366, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 682, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 359, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 681, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 354, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [684, 680, 683, 682, 681] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 345, "character": 17 } ] } } }, { "id": 254, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 256, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 1222, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [256] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 607, "name": "UserResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 169, "name": "verifyOtp", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 733, "character": 8 } ], "signatures": [ { "id": 170, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." }, "parameters": [ { "id": 171, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 781, "name": "VerifyOtpParams", "dereferenced": { "id": 781, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 596, "character": 12 } ], "type": { "type": "union", "types": [ { "id": 782, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 786, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 789, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site.", "tags": [ { "tag": "deprecated", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 788, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 606, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [789, 788] } ] } } }, { "id": 783, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 599, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 784, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The otp sent to the user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 601, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 785, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 603, "character": 2 } ], "type": { "type": "reference", "id": 801, "name": "MobileOtpType", "dereferenced": { "id": 801, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 643, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [786, 783, 784, 785] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 597, "character": 17 } ] }, { "id": 790, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 791, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 618, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 794, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 797, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site.", "tags": [ { "tag": "deprecated", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 631, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 796, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [797, 796] } ] } } }, { "id": 792, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The otp sent to the user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 620, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 793, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 622, "character": 2 } ], "type": { "type": "reference", "id": 802, "name": "EmailOtpType", "dereferenced": { "id": 802, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 644, "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" }, { "type": "literal", "value": "email" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [791, 794, 792, 793] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 616, "character": 17 } ] }, { "id": 798, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 799, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The token hash used in an email link" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 637, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 800, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 640, "character": 2 } ], "type": { "type": "reference", "id": 802, "name": "EmailOtpType", "dereferenced": { "id": 802, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 644, "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" }, { "type": "literal", "value": "email" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [799, 800] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 635, "character": 17 } ] } ] } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 515, "name": "AuthResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [80] }, { "title": "Properties", "kind": 1024, "children": [84, 85] }, { "title": "Methods", "kind": 2048, "children": [ 143, 182, 245, 349, 127, 359, 321, 175, 282, 179, 335, 270, 131, 163, 140, 166, 137, 172, 311, 134, 417, 419, 362, 251, 169 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 116, "character": 21 } ] }, { "id": 470, "name": "NavigatorLockAcquireTimeoutError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 471, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 472, "name": "new NavigatorLockAcquireTimeoutError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 473, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 470, "name": "NavigatorLockAcquireTimeoutError" }, "inheritedFrom": { "type": "reference", "name": "LockAcquireTimeoutError.constructor" } } ], "inheritedFrom": { "type": "reference", "name": "LockAcquireTimeoutError.constructor" } }, { "id": 474, "name": "isAcquireTimeout", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true, "isReadonly": true }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 24, "character": 18 } ], "type": { "type": "literal", "value": true }, "defaultValue": "true", "inheritedFrom": { "type": "reference", "name": "LockAcquireTimeoutError.isAcquireTimeout" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [471] }, { "title": "Properties", "kind": 1024, "children": [474] } ], "sources": [ { "fileName": "src/lib/locks.ts", "line": 31, "character": 13 } ], "extendedTypes": [ { "type": "reference", "name": "LockAcquireTimeoutError" } ] }, { "id": 627, "name": "AMREntry", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "An authentication methord reference (AMR) entry.", "text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n" } ] }, "children": [ { "id": 628, "name": "method", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Authentication method name." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 262, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 629, "name": "timestamp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 268, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [628, 629] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 260, "character": 17 } ] }, { "id": 685, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 687, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 398, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 690, "name": "ban_duration", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Determines how long a user is banned for.", "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 424, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 694, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 349, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.email" } }, { "id": 688, "name": "email_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 405, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 693, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", "text": "Call reauthenticate() to obtain the nonce first.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 366, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.nonce" } }, { "id": 692, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 359, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.password" } }, { "id": 695, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 354, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "Omit.phone" } }, { "id": 689, "name": "phone_confirm", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 412, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 691, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The `role` claim set in the user's access token JWT.", "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 433, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 686, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 388, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 377, "character": 17 } ], "extendedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 679, "name": "UserAttributes" }, { "type": "literal", "value": "data" } ], "qualifiedName": "Omit", "package": "typescript", "name": "Omit" } ] }, { "id": 642, "name": "Factor", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "A MFA factor.", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#enroll}" }, { "tag": "see", "text": "{@link GoTrueMFAApi#listFactors}" }, { "tag": "see", "text": "{@link GoTrueMFAAdminApi#listFactors}\n" } ] }, "children": [ { "id": 647, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 307, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 645, "name": "factor_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Type of factor. Only `totp` supported with this version but may change in\nfuture versions." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 302, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 644, "name": "friendly_name", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 296, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 643, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 293, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 646, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Factor's status." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 305, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "verified" }, { "type": "literal", "value": "unverified" } ] } }, { "id": 648, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 308, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [647, 645, 644, 643, 646, 648] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 291, "character": 17 } ] }, { "id": 852, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 853, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 728, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 854, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The URL which will be appended to the email link generated." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 730, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [853, 854] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 722, "character": 17 } ] }, { "id": 1012, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "Contains the full multi-factor authentication administration API.", "tags": [ { "tag": "expermental", "text": "\n" } ] }, "children": [ { "id": 1016, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1017, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#unenroll}\n" }, { "tag": "expermental", "text": "\n" } ] }, "parameters": [ { "id": 1018, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 996, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { "id": 996, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 997, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 998, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the MFA factor to delete." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1030, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 999, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user whose factor is being deleted." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1033, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [998, 999] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 45 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 987, "name": "AuthMFAAdminDeleteFactorResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 1013, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 1014, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Lists all factors associated to a user." }, "parameters": [ { "id": 1015, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 1009, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { "id": 1009, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1010, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1011, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1054, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1011] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 44 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 1000, "name": "AuthMFAAdminListFactorsResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [1016, 1013] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1062, "character": 17 } ] }, { "id": 967, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "Contains the full multi-factor authentication API." }, "children": [ { "id": 971, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 972, "name": "challenge", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." }, "parameters": [ { "id": 973, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 890, "name": "MFAChallengeParams", "dereferenced": { "id": 890, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 810, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 892, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor to be challenged. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 812, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [892] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 810, "character": 33 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 935, "name": "AuthMFAChallengeResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 980, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 981, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." }, "parameters": [ { "id": 982, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 893, "name": "MFAChallengeAndVerifyParams", "dereferenced": { "id": 893, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 815, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 894, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 896, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Verification code provided by the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 819, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 895, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 817, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [896, 895] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 815, "character": 42 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 897, "name": "AuthMFAVerifyResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 968, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 969, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" }, "parameters": [ { "id": 970, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 877, "name": "MFAEnrollParams", "dereferenced": { "id": 877, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 878, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 879, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of factor being enrolled." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 787, "character": 2 } ], "type": { "type": "literal", "value": "totp" } }, { "id": 881, "name": "friendlyName", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Human readable name assigned to the factor." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 791, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 880, "name": "issuer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Domain which the user is enrolled with." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 789, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [879, 881, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 785, "character": 30 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 910, "name": "AuthMFAEnrollResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 985, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 986, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 956, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 983, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 984, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the list of MFA factors enabled for this user.", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#enroll}" }, { "tag": "see", "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" }, { "tag": "see", "text": "{@link GoTrueClient#getUser}\n\n" } ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 945, "name": "AuthMFAListFactorsResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 977, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 978, "name": "unenroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." }, "parameters": [ { "id": 979, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 882, "name": "MFAUnenrollParams", "dereferenced": { "id": 882, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 794, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 883, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 884, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being unenrolled." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [884] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, "character": 32 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 926, "name": "AuthMFAUnenrollResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 974, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { "id": 975, "name": "verify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." }, "parameters": [ { "id": 976, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 885, "name": "MFAVerifyParams", "dereferenced": { "id": 885, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 799, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 888, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the challenge being verified. Returned in challenge()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 804, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 889, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Verification code provided by the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 887, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 801, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [888, 889, 887] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 799, "character": 30 } ] } } } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 897, "name": "AuthMFAVerifyResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Methods", "kind": 2048, "children": [971, 980, 968, 985, 983, 977, 974] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 949, "character": 17 } ] }, { "id": 618, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 621, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 235, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 624, "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": 247, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 623, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 243, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 620, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 231, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 619, "name": "provider_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 226, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 622, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "A one-time used refresh token that never expires." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 239, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 625, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 248, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 626, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 249, "character": 2 } ], "type": { "type": "reference", "id": 656, "name": "User", "dereferenced": { "id": 656, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 667, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 331, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 658, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 322, "character": 2 } ], "type": { "type": "reference", "id": 649, "name": "UserAppMetadata", "dereferenced": { "id": 649, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 650, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 312, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [650] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 311, "character": 17 } ], "indexSignature": { "id": 651, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 652, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 660, "name": "aud", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 324, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 661, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 325, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 671, "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 335, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 670, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 334, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 668, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 332, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 663, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 327, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 672, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 336, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 678, "name": "factors", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 342, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 642, "name": "Factor" } } }, { "id": 657, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 321, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 677, "name": "identities", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 341, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 630, "name": "UserIdentity" } } }, { "id": 666, "name": "invited_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 330, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 674, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 338, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 664, "name": "new_email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 328, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 665, "name": "new_phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 329, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 669, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 333, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 673, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 337, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 662, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 326, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 675, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 339, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 676, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 340, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 659, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 323, "character": 2 } ], "type": { "type": "reference", "id": 653, "name": "UserMetadata", "dereferenced": { "id": 653, "name": "UserMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 316, "character": 17 } ], "indexSignature": { "id": 654, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 655, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 667, 658, 660, 661, 671, 670, 668, 663, 672, 678, 657, 677, 666, 674, 664, 665, 669, 673, 662, 675, 676, 659 ] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 320, "character": 17 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [621, 624, 623, 620, 619, 622, 625, 626] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 222, "character": 17 } ] }, { "id": 696, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 697, "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": 440, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 698, "name": "callback", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 444, "character": 2 } ], "signatures": [ { "id": 699, "name": "callback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The function to call every time there is an event. eg: (eventName) => {}" }, "parameters": [ { "id": 700, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 480, "name": "AuthChangeEvent", "dereferenced": { "id": 480, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 30, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INITIAL_SESSION" }, { "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" }, { "id": 479, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 12 } ], "type": { "type": "literal", "value": "MFA_CHALLENGE_VERIFIED" } } ] } } } }, { "id": 701, "name": "session", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 618, "name": "Session" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 702, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 448, "character": 2 } ], "signatures": [ { "id": 703, "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": [697] }, { "title": "Methods", "kind": 2048, "children": [698, 702] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 436, "character": 17 } ] }, { "id": 704, "name": "UpdatableFactorAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 705, "name": "friendlyName", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 452, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [705] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 451, "character": 17 } ] }, { "id": 656, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 667, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 331, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 658, "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 322, "character": 2 } ], "type": { "type": "reference", "id": 649, "name": "UserAppMetadata", "dereferenced": { "id": 649, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 650, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 312, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [650] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 311, "character": 17 } ], "indexSignature": { "id": 651, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 652, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 660, "name": "aud", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 324, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 661, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 325, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 671, "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 335, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 670, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 334, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 668, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 332, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 663, "name": "email_change_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 327, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 672, "name": "email_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 336, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 678, "name": "factors", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 342, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 642, "name": "Factor" } } }, { "id": 657, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 321, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 677, "name": "identities", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 341, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 630, "name": "UserIdentity" } } }, { "id": 666, "name": "invited_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 330, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 674, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 338, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 664, "name": "new_email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 328, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 665, "name": "new_phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 329, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 669, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 333, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 673, "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 337, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 662, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 326, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 675, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 339, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 676, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 340, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 659, "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 323, "character": 2 } ], "type": { "type": "reference", "id": 653, "name": "UserMetadata", "dereferenced": { "id": 653, "name": "UserMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 316, "character": 17 } ], "indexSignature": { "id": 654, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 655, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 667, 658, 660, 661, 671, 670, 668, 663, 672, 678, 657, 677, 666, 674, 664, 665, 669, 673, 662, 675, 676, 659 ] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 320, "character": 17 } ] }, { "id": 649, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 650, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 312, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [650] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 311, "character": 17 } ], "indexSignature": { "id": 651, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 652, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } }, { "id": 679, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 684, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 374, "character": 2 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 680, "name": "email", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's email." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 349, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 683, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", "text": "Call reauthenticate() to obtain the nonce first.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 366, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 682, "name": "password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 359, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 681, "name": "phone", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The user's phone." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 354, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [684, 680, 683, 682, 681] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 345, "character": 17 } ] }, { "id": 630, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 639, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 279, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 631, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 272, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 633, "name": "identity_data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 274, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 634, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 635, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 636, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 637, "name": "identity_id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 277, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 640, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 280, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 638, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 278, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 641, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 281, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 632, "name": "user_id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 273, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [639, 631, 633, 637, 640, 638, 641, 632] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 271, "character": 17 } ] }, { "id": 653, "name": "UserMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 316, "character": 17 } ], "indexSignature": { "id": 654, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 655, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } }, { "id": 790, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 791, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 618, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 794, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 797, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site.", "tags": [ { "tag": "deprecated", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 631, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 796, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [797, 796] } ] } } }, { "id": 792, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The otp sent to the user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 620, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 793, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 622, "character": 2 } ], "type": { "type": "reference", "id": 802, "name": "EmailOtpType", "dereferenced": { "id": 802, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 644, "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" }, { "type": "literal", "value": "email" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [791, 794, 792, 793] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 616, "character": 17 } ] }, { "id": 782, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 786, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 789, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site.", "tags": [ { "tag": "deprecated", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 788, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 606, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [789, 788] } ] } } }, { "id": 783, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 599, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 784, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The otp sent to the user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 601, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 785, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 603, "character": 2 } ], "type": { "type": "reference", "id": 801, "name": "MobileOtpType", "dereferenced": { "id": 801, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 643, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [786, 783, 784, 785] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 597, "character": 17 } ] }, { "id": 798, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 799, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The token hash used in an email link" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 637, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 800, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 640, "character": 2 } ], "type": { "type": "reference", "id": 802, "name": "EmailOtpType", "dereferenced": { "id": 802, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 644, "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" }, { "type": "literal", "value": "email" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [799, 800] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 635, "character": 17 } ] }, { "id": 480, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 30, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INITIAL_SESSION" }, { "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" }, { "id": 479, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 12 } ], "type": { "type": "literal", "value": "MFA_CHALLENGE_VERIFIED" } } ] } }, { "id": 479, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 28, "character": 12 } ], "type": { "type": "literal", "value": "MFA_CHALLENGE_VERIFIED" } }, { "id": 759, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 565, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "implicit" }, { "type": "literal", "value": "pkce" } ] } }, { "id": 996, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 997, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 998, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the MFA factor to delete." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1030, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 999, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user whose factor is being deleted." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1033, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [998, 999] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1028, "character": 45 } ] } } }, { "id": 987, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1015, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 989, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1017, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 990, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 991, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor that was successfully deleted." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1019, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [991] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1017, "character": 12 } ] } } }, { "id": 992, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1021, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [989, 992] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1016, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 993, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 994, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1023, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 995, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1023, "character": 18 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [994, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1023, "character": 4 } ] } } ] } }, { "id": 1009, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1010, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1011, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1054, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1011] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1052, "character": 44 } ] } } }, { "id": 1000, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "tags": [ { "tag": "expermental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1039, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1001, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1002, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1041, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 1003, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1004, "name": "factors", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "All factors attached to the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1043, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 642, "name": "Factor" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1004] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1041, "character": 12 } ] } } }, { "id": 1005, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1045, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1002, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1040, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 1006, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1007, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1047, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 1008, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1047, "character": 18 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1007, 1008] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1047, "character": 4 } ] } } ] } }, { "id": 935, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 892, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 936, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 937, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 894, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 938, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 940, "name": "expires_at", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 899, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 939, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the newly created challenge." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 896, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [940, 939] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 894, "character": 12 } ] } } }, { "id": 941, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 901, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [937, 941] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 893, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 942, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 943, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 903, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 944, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 903, "character": 18 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [943, 944] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 903, "character": 4 } ] } } ] } }, { "id": 910, "name": "AuthMFAEnrollResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 847, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 911, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 912, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 849, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 913, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 921, "name": "friendly_name", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Friendly name of the factor, useful for distinguishing between factors" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 873, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 914, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor that was just enrolled (in an unverified state)." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 851, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 916, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "TOTP enrollment information." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 857, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 918, "name": "qr_code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 861, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 919, "name": "secret", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 866, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 920, "name": "uri", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 870, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [918, 919, 920] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 857, "character": 14 } ] } } }, { "id": 915, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Type of MFA factor. Only `totp` supported for now." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 854, "character": 8 } ], "type": { "type": "literal", "value": "totp" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [921, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 849, "character": 12 } ] } } }, { "id": 922, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 875, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [912, 922] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 848, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 923, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 924, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 878, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 925, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 879, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [924, 925] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 877, "character": 4 } ] } } ] } }, { "id": 956, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 957, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 958, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 922, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 959, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 962, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 939, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 627, "name": "AMREntry" } } }, { "id": 960, "name": "currentLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Current AAL level of the session." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 924, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 955, "name": "AuthenticatorAssuranceLevels" }, { "type": "literal", "value": null } ] } }, { "id": 961, "name": "nextLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.", "tags": [ { "tag": "see", "text": "{@link GoTrueMFAApi#challenge}\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 932, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 955, "name": "AuthenticatorAssuranceLevels" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [962, 960, 961] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 922, "character": 12 } ] } } }, { "id": 963, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 941, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [958, 963] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 921, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 964, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 965, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 943, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 966, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 943, "character": 18 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [965, 966] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 943, "character": 4 } ] } } ] } }, { "id": 945, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 905, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 946, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 947, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 907, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 948, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 949, "name": "all", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "All available factors (verified and unverified)." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 909, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 642, "name": "Factor" } } }, { "id": 950, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Only verified TOTP factors. (A subset of `all`.)" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 642, "name": "Factor" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 907, "character": 12 } ] } } }, { "id": 951, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 914, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [947, 951] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 906, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 953, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 916, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 954, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 916, "character": 18 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [953, 954] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 916, "character": 4 } ] } } ] } }, { "id": 926, "name": "AuthMFAUnenrollResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 882, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 927, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 928, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 884, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 929, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 930, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor that was successfully unenrolled." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 886, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [930] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 884, "character": 12 } ] } } }, { "id": 931, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 888, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [928, 931] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 883, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 932, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 933, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 890, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 934, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 890, "character": 18 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [933, 934] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 890, "character": 4 } ] } } ] } }, { "id": 897, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 822, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 898, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 899, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 824, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 900, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 901, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "New access token (JWT) after successful verification." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 826, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 903, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Number of seconds in which the access token will expire." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 832, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 904, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Refresh token you can use to obtain new access tokens when expired." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 835, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 902, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Type of token, typically `Bearer`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 829, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 905, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Updated user profile." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 838, "character": 8 } ], "type": { "type": "reference", "id": 656, "name": "User" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [901, 903, 904, 902, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 824, "character": 12 } ] } } }, { "id": 906, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 840, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [899, 906] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 823, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 907, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 908, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 843, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 909, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 844, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [908, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 842, "character": 4 } ] } } ] } }, { "id": 542, "name": "AuthOtpResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "AuthOtpResponse is returned when OTP is used.", "text": "{@see AuthRsponse}\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 129, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 543, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 544, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 131, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 545, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 548, "name": "messageId", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 131, "character": 41 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] } }, { "id": 547, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 131, "character": 26 } ], "type": { "type": "literal", "value": null } }, { "id": 546, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 131, "character": 14 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [548, 547, 546] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 131, "character": 12 } ] } } }, { "id": 549, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 132, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [544, 549] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 130, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 550, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 551, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 135, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 552, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 555, "name": "messageId", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 135, "character": 41 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] } }, { "id": 554, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 135, "character": 26 } ], "type": { "type": "literal", "value": null } }, { "id": 553, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 135, "character": 14 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [555, 554, 553] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 135, "character": 12 } ] } } }, { "id": 556, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 136, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [551, 556] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 134, "character": 4 } ] } } ] } }, { "id": 515, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 91, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 516, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 517, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 93, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 520, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 95, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 618, "name": "Session" }, { "type": "literal", "value": null } ] } }, { "id": 519, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 94, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 656, "name": "User" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [520, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 93, "character": 12 } ] } } }, { "id": 521, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [517, 521] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 92, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 522, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 523, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 100, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 524, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 526, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 102, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 525, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 101, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [526, 525] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 100, "character": 12 } ] } } }, { "id": 527, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 104, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [523, 527] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 99, "character": 4 } ] } } ] } }, { "id": 528, "name": "AuthResponsePassword", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 107, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 529, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 530, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 109, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 531, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 533, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 111, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 618, "name": "Session" }, { "type": "literal", "value": null } ] } }, { "id": 532, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 110, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 656, "name": "User" }, { "type": "literal", "value": null } ] } }, { "id": 534, "name": "weak_password", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 112, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 511, "name": "WeakPassword" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [533, 532, 534] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 109, "character": 12 } ] } } }, { "id": 535, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 114, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [530, 535] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 108, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 536, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 537, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 117, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 538, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 540, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 119, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 539, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 118, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [540, 539] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 117, "character": 12 } ] } } }, { "id": 541, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 121, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [537, 541] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 116, "character": 4 } ] } } ] } }, { "id": 557, "name": "AuthTokenResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 139, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 558, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 559, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 141, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 560, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 562, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 143, "character": 8 } ], "type": { "type": "reference", "id": 618, "name": "Session" } }, { "id": 561, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 142, "character": 8 } ], "type": { "type": "reference", "id": 656, "name": "User" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [562, 561] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 141, "character": 12 } ] } } }, { "id": 563, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 145, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [559, 563] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 140, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 564, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 565, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 148, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 566, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 568, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 150, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 567, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 149, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [568, 567] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 148, "character": 12 } ] } } }, { "id": 569, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 152, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [565, 569] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 147, "character": 4 } ] } } ] } }, { "id": 570, "name": "AuthTokenResponsePassword", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 155, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 571, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 572, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 157, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 573, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 575, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 159, "character": 8 } ], "type": { "type": "reference", "id": 618, "name": "Session" } }, { "id": 574, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 158, "character": 8 } ], "type": { "type": "reference", "id": 656, "name": "User" } }, { "id": 576, "name": "weakPassword", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 160, "character": 8 } ], "type": { "type": "reference", "id": 511, "name": "WeakPassword" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [575, 574, 576] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 157, "character": 12 } ] } } }, { "id": 577, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 162, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [572, 577] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 156, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 578, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 579, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 165, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 580, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 582, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 167, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 581, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 166, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 583, "name": "weakPassword", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 168, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [582, 581, 583] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 165, "character": 12 } ] } } }, { "id": 584, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 170, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [579, 584] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 164, "character": 4 } ] } } ] } }, { "id": 955, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 918, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "aal1" }, { "type": "literal", "value": "aal2" } ] } }, { "id": 1025, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1104, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1026, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1028, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1107, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 1027, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1106, "character": 6 } ], "type": { "type": "reference", "id": 618, "name": "Session" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1028, 1027] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1105, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1031, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1111, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } }, { "id": 1030, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1110, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1031, 1030] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1109, "character": 4 } ] } } ] } }, { "id": 802, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 644, "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" }, { "type": "literal", "value": "email" } ] } }, { "id": 846, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 849, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 714, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 850, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 718, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 851, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 719, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 848, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 712, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [849, 850, 851, 848] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 44 } ] } } }, { "id": 836, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 839, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 700, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 840, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 701, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 838, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 698, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [839, 840, 838] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 46 } ] } } }, { "id": 855, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 733, "character": 12 } ], "type": { "type": "union", "types": [ { "id": 830, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 831, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 833, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 835, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 694, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 834, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 693, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 832, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 691, "character": 2 } ], "type": { "type": "literal", "value": "signup" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [833, 835, 834, 832] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 39 } ] } } }, { "id": 836, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 837, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 839, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 700, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 840, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 701, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 838, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 698, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [839, 840, 838] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 697, "character": 46 } ] } } }, { "id": 841, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 844, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 707, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 845, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 708, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 843, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 705, "character": 2 } ], "type": { "type": "literal", "value": "recovery" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [844, 845, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 41 } ] } } }, { "id": 846, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 849, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 714, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 850, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 718, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 851, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 719, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 848, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 712, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [849, 850, 851, 848] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, "character": 44 } ] } } } ] } }, { "id": 869, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "The properties related to the email link generated" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 756, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 870, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 871, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 761, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 872, "name": "email_otp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 766, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 873, "name": "hashed_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The hashed token appended to the action link." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 770, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 874, "name": "redirect_to", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The URL appended to the action link." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 772, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 875, "name": "verification_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The verification type that the email link is associated to." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 774, "character": 2 } ], "type": { "type": "reference", "id": 876, "name": "GenerateLinkType", "dereferenced": { "id": 876, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 777, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "signup" }, { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" }, { "type": "literal", "value": "recovery" }, { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [871, 872, 873, 874, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 756, "character": 37 } ] } } }, { "id": 856, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 739, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 857, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 858, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 859, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 860, "name": "properties", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 742, "character": 8 } ], "type": { "type": "reference", "id": 869, "name": "GenerateLinkProperties" } }, { "id": 861, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, "character": 8 } ], "type": { "type": "reference", "id": 656, "name": "User" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [860, 861] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 741, "character": 12 } ] } } }, { "id": 862, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [858, 862] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 740, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 864, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 866, "name": "properties", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 749, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 867, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 750, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [866, 867] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 748, "character": 12 } ] } } }, { "id": 868, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 752, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [864, 868] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 747, "character": 4 } ] } } ] } }, { "id": 876, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 777, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "signup" }, { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" }, { "type": "literal", "value": "recovery" }, { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } }, { "id": 841, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 844, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 707, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 845, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 708, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "literal", "value": "redirectTo" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 843, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 705, "character": 2 } ], "type": { "type": "literal", "value": "recovery" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [844, 845, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 704, "character": 41 } ] } } }, { "id": 830, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 831, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 833, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 835, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 694, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 852, "name": "GenerateLinkOptions" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 834, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 693, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 832, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 691, "character": 2 } ], "type": { "type": "literal", "value": "signup" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [833, 835, 834, 832] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, "character": 39 } ] } } }, { "id": 490, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 491, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 499, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 66, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 504, "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 76, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 76, "character": 21 } ], "signatures": [ { "id": 506, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 507, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 508, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } ] } }, { "id": 498, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 502, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 72, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 503, "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, "character": 2 } ], "type": { "type": "reference", "id": 759, "name": "AuthFlowType", "dereferenced": { "id": 759, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 565, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "implicit" }, { "type": "literal", "value": "pkce" } ] } } } }, { "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 494, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, "character": 12 } ], "indexSignature": { "id": 495, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 496, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 509, "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, "character": 2 } ], "type": { "type": "reference", "id": 481, "name": "LockFunc", "dereferenced": { "id": 481, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 482, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 23 } ], "signatures": [ { "id": 483, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "typeParameter": [ { "id": 489, "name": "R", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 484, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Name of the lock to be acquired." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 485, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 486, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operation to execute when the lock is acquired.\n" }, "type": { "type": "reflection", "declaration": { "id": 487, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 69 } ], "signatures": [ { "id": 488, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 489, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 489, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } } }, { "id": 500, "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 501, "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 70, "character": 2 } ], "type": { "type": "reference", "id": 1019, "name": "SupportedStorage", "dereferenced": { "id": 1019, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1089, "character": 12 } ], "type": { "type": "intersection", "types": [ { "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" }, { "type": "reflection", "declaration": { "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1021, "name": "isServer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1099, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1021] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1091, "character": 4 } ] } } ] } } } }, { "id": 497, "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 62, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 492, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 58, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [499, 504, 498, 502, 503, 493, 509, 500, 501, 497, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 56, "character": 34 } ] } } }, { "id": 1022, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1102, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1023, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1024, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1102, "character": 33 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 1058, "name": "AuthError" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1024] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1102, "character": 31 } ] } } }, { "id": 481, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 482, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 23 } ], "signatures": [ { "id": 483, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", "tags": [ { "tag": "experimental", "text": "\n" } ] }, "typeParameter": [ { "id": 489, "name": "R", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 484, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Name of the lock to be acquired." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 485, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 486, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operation to execute when the lock is acquired.\n" }, "type": { "type": "reflection", "declaration": { "id": 487, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 54, "character": 69 } ], "signatures": [ { "id": 488, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 489, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 489, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 893, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 815, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 894, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 896, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Verification code provided by the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 819, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 895, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 817, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [896, 895] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 815, "character": 42 } ] } } }, { "id": 890, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 810, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 892, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor to be challenged. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 812, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [892] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 810, "character": 33 } ] } } }, { "id": 877, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 878, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 879, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of factor being enrolled." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 787, "character": 2 } ], "type": { "type": "literal", "value": "totp" } }, { "id": 881, "name": "friendlyName", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Human readable name assigned to the factor." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 791, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 880, "name": "issuer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Domain which the user is enrolled with." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 789, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [879, 881, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 785, "character": 30 } ] } } }, { "id": 882, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 794, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 883, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 884, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being unenrolled." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [884] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, "character": 32 } ] } } }, { "id": 885, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 799, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 888, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the challenge being verified. Returned in challenge()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 804, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 889, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Verification code provided by the user." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 887, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 801, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [888, 889, 887] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 799, "character": 30 } ] } } }, { "id": 801, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 643, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } }, { "id": 585, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 173, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 586, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 587, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 175, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 588, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 589, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 176, "character": 8 } ], "type": { "type": "reference", "id": 478, "name": "Provider" } }, { "id": 590, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 177, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [589, 590] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 175, "character": 12 } ] } } }, { "id": 591, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 179, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [587, 591] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 174, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 592, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 593, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 182, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 594, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 595, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 183, "character": 8 } ], "type": { "type": "reference", "id": 478, "name": "Provider" } }, { "id": 596, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 184, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [595, 596] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 182, "character": 12 } ] } } }, { "id": 597, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 186, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [593, 597] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 181, "character": 4 } ] } } ] } }, { "id": 1039, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1121, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1040, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1041, "name": "page", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The page number" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1123, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1042, "name": "perPage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Number of items returned per page" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1041, 1042] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1121, "character": 25 } ] } } }, { "id": 1032, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1114, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1033, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1035, "name": "lastPage", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1117, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1034, "name": "nextPage", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1116, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "number" }, { "type": "literal", "value": null } ] } }, { "id": 1036, "name": "total", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1118, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1035, 1034, 1036] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1114, "character": 25 } ], "indexSignature": { "id": 1037, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 1038, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 478, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 5, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "bitbucket" }, { "type": "literal", "value": "discord" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "figma" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "kakao" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "linkedin_oidc" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "workos" }, { "type": "literal", "value": "zoom" }, { "type": "literal", "value": "fly" } ] } }, { "id": 803, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 804, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 806, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 807, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 650, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 808, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 654, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 809, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they have signed-in." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 652, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [810, 809] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 650, "character": 16 } ] } } }, { "id": 805, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 648, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 802, "name": "EmailOtpType" }, { "type": "union", "types": [ { "type": "literal", "value": "signup" }, { "type": "literal", "value": "email_change" } ] } ], "qualifiedName": "Extract", "package": "typescript", "name": "Extract" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [806, 807, 805] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 647, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 811, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 814, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 660, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 815, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 816, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 662, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [816] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 660, "character": 16 } ] } } }, { "id": 813, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 659, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 812, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 658, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 801, "name": "MobileOtpType" }, { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } ], "qualifiedName": "Extract", "package": "typescript", "name": "Extract" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [814, 813, 812] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 657, "character": 4 } ] } } ] } }, { "id": 598, "name": "SSOResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 189, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 599, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 600, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 191, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 601, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 602, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.", "text": "On browsers you can set the URL to `window.location.href` to take\nthe user to the authentication flow.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 199, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [602] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 191, "character": 12 } ] } } }, { "id": 603, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 201, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [600, 603] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 190, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 604, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 605, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 204, "character": 6 } ], "type": { "type": "literal", "value": null } }, { "id": 606, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 205, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [605, 606] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 203, "character": 4 } ] } } ] } }, { "id": 706, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 455, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 707, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 708, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 709, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 711, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 464, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 710, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 462, "character": 4 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [711, 710] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 456, "character": 12 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [708] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 455, "character": 43 } ] } } }, { "id": 772, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 581, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 773, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 776, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 587, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 777, "name": "nonce", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 589, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 778, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 590, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 779, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 780, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 592, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [780] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 590, "character": 12 } ] } } }, { "id": 774, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `keycloak` (deprecated)." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 583, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "google" }, { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "facebook" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 775, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 585, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [776, 777, 778, 774, 775] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 581, "character": 43 } ] } } }, { "id": 760, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 761, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 763, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 764, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 767, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "An object of query params" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 575, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 768, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 575, "character": 18 } ], "indexSignature": { "id": 769, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 770, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 765, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 766, "name": "scopes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A space-separated list of scopes granted to the OAuth application." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 573, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 771, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [767, 765, 766, 771] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 569, "character": 12 } ] } } }, { "id": 762, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 568, "character": 2 } ], "type": { "type": "reference", "id": 478, "name": "Provider", "dereferenced": { "id": 478, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 5, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "bitbucket" }, { "type": "literal", "value": "discord" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "figma" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "kakao" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "linkedin_oidc" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "workos" }, { "type": "literal", "value": "zoom" }, { "type": "literal", "value": "fly" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [763, 762] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 566, "character": 41 } ] } } }, { "id": 729, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 505, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 730, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 731, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 508, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 733, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 511, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 734, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 735, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 513, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [735] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 511, "character": 16 } ] } } }, { "id": 732, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 510, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [731, 733, 732] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 506, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 736, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 739, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 521, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 740, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 741, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 523, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [741] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 521, "character": 16 } ] } } }, { "id": 738, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 520, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 737, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 518, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [739, 738, 737] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 516, "character": 4 } ] } } ] } }, { "id": 742, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 527, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 743, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 744, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 530, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 745, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 531, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 746, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 750, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 543, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 749, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 541, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 747, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The redirect url embedded in the email link" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 533, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 748, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to false, this method will not create a new user. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 535, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [750, 749, 747, 748] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 531, "character": 16 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [744, 745] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 528, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 751, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 753, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 549, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 757, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 559, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 758, "name": "channel", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Messaging channel to use (e.g. whatsapp or sms)" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 561, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "whatsapp" } ] } }, { "id": 756, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 557, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 755, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to false, this method will not create a new user. Defaults to true." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 551, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [757, 758, 756, 755] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 549, "character": 16 } ] } } }, { "id": 752, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 548, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [753, 752] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 546, "character": 4 } ] } } ] } }, { "id": 817, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 666, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 818, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 820, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 671, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 823, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 675, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 822, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they have signed-in." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 673, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [823, 822] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 671, "character": 16 } ] } } }, { "id": 819, "name": "providerId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "UUID of the SSO provider to invoke single-sign on to." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 669, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [820, 819] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 667, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 824, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 825, "name": "domain", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "Domain name of the organization for which to invoke single-sign on." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 680, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 826, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 682, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 827, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 829, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 686, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 828, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they have signed-in." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 684, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [829, 828] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 682, "character": 16 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [825, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 678, "character": 4 } ] } } ] } }, { "id": 1043, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1128, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1045, "name": "scope", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1139, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "global" }, { "type": "literal", "value": "local" }, { "type": "literal", "value": "others" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1128, "character": 22 } ] } } }, { "id": 712, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 468, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 713, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 714, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 471, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 716, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 474, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 717, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 720, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 484, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 719, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 482, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 718, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The redirect url embedded in the email link" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 476, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [720, 719, 718] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 474, "character": 16 } ] } } }, { "id": 715, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 473, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [714, 716, 715] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 469, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 721, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 724, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 492, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 725, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 727, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 500, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 728, "name": "channel", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Messaging channel to use (e.g. whatsapp or sms)" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 502, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "whatsapp" } ] } }, { "id": 726, "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 498, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [727, 728, 726] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 492, "character": 16 } ] } } }, { "id": 723, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 491, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 722, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 489, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [724, 723, 722] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 487, "character": 4 } ] } } ] } }, { "id": 1019, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 1089, "character": 12 } ], "type": { "type": "intersection", "types": [ { "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" }, { "type": "reflection", "declaration": { "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 1021, "name": "isServer", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1099, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [1021] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1091, "character": 4 } ] } } ] } }, { "id": 607, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 208, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 609, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 210, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 610, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 611, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 211, "character": 8 } ], "type": { "type": "reference", "id": 656, "name": "User" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [611] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 210, "character": 12 } ] } } }, { "id": 612, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 213, "character": 6 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [609, 612] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 209, "character": 4 } ] } }, { "type": "reflection", "declaration": { "id": 613, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 614, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 216, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 615, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 616, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 217, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [616] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 216, "character": 12 } ] } } }, { "id": 617, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 219, "character": 6 } ], "type": { "type": "reference", "id": 1058, "name": "AuthError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [614, 617] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 215, "character": 4 } ] } } ] } }, { "id": 781, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 596, "character": 12 } ], "type": { "type": "union", "types": [ { "id": 782, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 786, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 787, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 789, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site.", "tags": [ { "tag": "deprecated", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 788, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 606, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [789, 788] } ] } } }, { "id": 783, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 599, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 784, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The otp sent to the user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 601, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 785, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 603, "character": 2 } ], "type": { "type": "reference", "id": 801, "name": "MobileOtpType", "dereferenced": { "id": 801, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 643, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [786, 783, 784, 785] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 597, "character": 17 } ] }, { "id": 790, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 791, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 618, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 794, "name": "options", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 797, "name": "captchaToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Verification token received when the user completes the captcha on the site.", "tags": [ { "tag": "deprecated", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 631, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 796, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [797, 796] } ] } } }, { "id": 792, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The otp sent to the user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 620, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 793, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 622, "character": 2 } ], "type": { "type": "reference", "id": 802, "name": "EmailOtpType", "dereferenced": { "id": 802, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 644, "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" }, { "type": "literal", "value": "email" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [791, 794, 792, 793] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 616, "character": 17 } ] }, { "id": 798, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 799, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The token hash used in an email link" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 637, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 800, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The user's verification type." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 640, "character": 2 } ], "type": { "type": "reference", "id": 802, "name": "EmailOtpType", "dereferenced": { "id": 802, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 644, "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" }, { "type": "literal", "value": "email" } ] } } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [799, 800] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 635, "character": 17 } ] } ] } }, { "id": 511, "name": "WeakPassword", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 86, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 512, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 514, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 88, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 513, "name": "reasons", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 87, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 510, "name": "WeakPasswordReasons" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [514, 513] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 86, "character": 27 } ] } } }, { "id": 510, "name": "WeakPasswordReasons", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 85, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "length" }, { "type": "literal", "value": "characters" }, { "type": "literal", "value": "pwned" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 460, "name": "AuthAdminApi", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/AuthAdminApi.ts", "line": 3, "character": 6 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 1, "name": "default" } }, "defaultValue": "GoTrueAdminApi" }, { "id": 461, "name": "AuthClient", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/AuthClient.ts", "line": 3, "character": 6 } ], "type": { "type": "query", "queryType": { "type": "reference", "id": 78, "name": "default" } }, "defaultValue": "GoTrueClient" }, { "id": 475, "name": "lockInternals", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "comment": { "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 6, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 476, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 477, "name": "debug", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "tags": [ { "tag": "experimental", "text": "\n" } ] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 10, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "!!(\n globalThis &&\n supportsLocalStorage() &&\n globalThis.localStorage &&\n globalThis.localStorage.getItem('supabase.gotrue-js.locks.debug') === 'true'\n )" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [477] } ] } }, "defaultValue": "..." }, { "id": 1049, "name": "isAuthApiError", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 36, "character": 16 } ], "signatures": [ { "id": 1050, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1051, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "id": 1065, "name": "AuthApiError" } } } ] }, { "id": 1046, "name": "isAuthError", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, "character": 16 } ], "signatures": [ { "id": 1047, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1048, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "id": 1058, "name": "AuthError" } } } ] }, { "id": 1052, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 126, "character": 16 } ], "signatures": [ { "id": 1053, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1054, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "id": 1188, "name": "AuthRetryableFetchError" } } } ] }, { "id": 1055, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 148, "character": 16 } ], "signatures": [ { "id": 1056, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 1057, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "id": 1202, "name": "AuthWeakPasswordError" } } } ] }, { "id": 462, "name": "navigatorLock", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/locks.ts", "line": 58, "character": 22 } ], "signatures": [ { "id": 463, "name": "navigatorLock", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring {@link\nGoTrueClient}.", "text": "You can turn on debugging by setting the `supabase.gotrue-js.locks.debug`\nlocal storage item to `true`.\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the `request` method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the `fn`\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway.\n" }, "typeParameter": [ { "id": 464, "name": "R", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 465, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Name of the lock to be acquired." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 466, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 467, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operation to run once the lock is acquired.\n" }, "type": { "type": "reflection", "declaration": { "id": 468, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 469, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 464, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 464, "name": "R" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [1065, 1058, 1138, 1125, 1113, 1163, 1188, 1101, 1078, 1202, 1086, 1, 78, 470] }, { "title": "Interfaces", "kind": 256, "children": [ 627, 685, 642, 852, 1012, 967, 618, 696, 704, 656, 649, 679, 630, 653, 790, 782, 798 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ 480, 479, 759, 996, 987, 1009, 1000, 935, 910, 956, 945, 926, 897, 542, 515, 528, 557, 570, 955, 1025, 802, 846, 836, 855, 869, 856, 876, 841, 830, 490, 1022, 481, 893, 890, 877, 882, 885, 801, 585, 1039, 1032, 478, 803, 598, 706, 772, 760, 729, 742, 817, 1043, 712, 1019, 607, 781, 511, 510 ] }, { "title": "Variables", "kind": 32, "children": [460, 461, 475] }, { "title": "Functions", "kind": 64, "children": [1049, 1046, 1052, 1055, 462] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 0, "name": "@supabase/postgrest-js", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 609, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", "flags": { "isAbstract": true }, "children": [ { "id": 610, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 20, "character": 2 } ], "signatures": [ { "id": 611, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 612, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 613, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default", "dereferenced": { "id": 609, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", "flags": { "isAbstract": true }, "children": "[Circular ~.children.0.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [610] }, { "title": "Properties", "kind": 1024, "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] }, { "title": "Methods", "kind": 2048, "children": [629, 627] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 7, "character": 30 } ], "typeParameter": [ { "id": 641, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedBy": [ { "type": "reference", "id": 489, "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } } ], "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default" } } ] }, { "id": 618, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 621, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 622, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 623, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 624, "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": 625, "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": 616, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 626, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 18, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 614, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 617, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 619, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 620, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } }, { "id": 615, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 629, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 50, "character": 2 } ], "signatures": [ { "id": 630, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 631, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 632, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 633, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 634, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 635, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 636, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 474, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 637, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 638, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 639, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 640, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "id": 475, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "implementationOf": { "type": "reference", "name": "PromiseLike.then" } } ], "implementationOf": { "type": "reference", "name": "PromiseLike.then" } }, { "id": 627, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 45, "character": 2 } ], "signatures": [ { "id": 628, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [610] }, { "title": "Properties", "kind": 1024, "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] }, { "title": "Methods", "kind": 2048, "children": [629, 627] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 7, "character": 30 } ], "typeParameter": [ { "id": 641, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedBy": [ { "type": "reference", "id": 489, "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] }, { "id": 1, "name": "PostgrestClient", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "PostgREST client." }, "children": [ { "id": 2, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 41, "character": 2 } ], "signatures": [ { "id": 3, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Creates a PostgREST client." }, "typeParameter": [ { "id": 4, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 5, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } } ] } } }, { "id": 6, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 5, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "extendsType": { "type": "reference", "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ], "parameters": [ { "id": 7, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "URL of the PostgREST endpoint" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 8, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 9, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 12, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 50, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 13, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 14, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Custom fetch\n" }, "parameters": [ { "id": 15, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 16, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 10, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Custom headers" }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 48, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 11, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Postgres schema to switch to" }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 49, "character": 6 } ], "type": { "type": "reference", "id": 5, "name": "SchemaName", "dereferenced": {} } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [12, 10, 11] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 1, "typeArguments": [ { "type": "reference", "id": 4, "name": "Database" }, { "type": "reference", "id": 5, "name": "SchemaName" }, { "type": "reference", "id": 6, "name": "Schema" } ], "name": "default" } } ] }, { "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 24, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 19, "name": "schemaName", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reference", "id": 5, "name": "SchemaName", "dereferenced": {} } }, { "id": 17, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 26, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 25, "name": "from", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 26, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { "id": 27, "name": "TableName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 28, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericTable" } } ], "parameters": [ { "id": 29, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table or view name to query\n" }, "type": { "type": "reference", "id": 27, "name": "TableName", "dereferenced": {} } } ], "type": { "type": "reference", "id": 56, "typeArguments": [ { "type": "reference", "id": 6, "name": "Schema" }, { "type": "reference", "id": 28, "name": "Table" }, { "type": "reference", "id": 27, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", "id": 28, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { "id": 30, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 31, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "reference", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [31] } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } ], "name": "default" } }, { "id": 32, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { "id": 33, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 34, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericView" } } ], "parameters": [ { "id": 35, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table or view name to query\n" }, "type": { "type": "reference", "id": 33, "name": "ViewName", "dereferenced": {} } } ], "type": { "type": "reference", "id": 56, "typeArguments": [ { "type": "reference", "id": 6, "name": "Schema" }, { "type": "reference", "id": 34, "name": "View" }, { "type": "reference", "id": 33, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", "id": 34, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { "id": 36, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 37, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "reference", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [37] } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } ], "name": "default" } } ] }, { "id": 42, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 124, "character": 2 } ], "signatures": [ { "id": 43, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a function call." }, "typeParameter": [ { "id": 44, "name": "FnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 45, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericFunction" } } ], "parameters": [ { "id": 46, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The function name to call" }, "type": { "type": "reference", "id": 44, "name": "FnName", "dereferenced": {} } }, { "id": 47, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The arguments to pass to the function call" }, "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Args" }, "objectType": { "type": "reference", "id": 45, "name": "Fn" } }, "defaultValue": "{}" }, { "id": 48, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 49, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 52, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 134, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 51, "name": "get", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When set to `true`, the function will be called with\nread-only access mode." }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 133, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 50, "name": "head", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 132, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [52, 51, 50] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 6, "name": "Schema" }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Returns" }, "objectType": { "type": "reference", "id": 45, "name": "Fn" } }, "extendsType": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } }, "trueType": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } } }, "extendsType": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "never" } }, "falseType": { "type": "intrinsic", "name": "never" } }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Returns" }, "objectType": { "type": "reference", "id": 45, "name": "Fn" } }, { "type": "intrinsic", "name": "unknown" }, { "type": "intrinsic", "name": "unknown" } ], "name": "default" } } ] }, { "id": 38, "name": "schema", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 87, "character": 2 } ], "signatures": [ { "id": 39, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Select a schema to query or perform an function (rpc) call.", "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" }, "typeParameter": [ { "id": 40, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 41, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The schema to query\n" }, "type": { "type": "reference", "id": 40, "name": "DynamicSchema", "dereferenced": {} } } ], "type": { "type": "reference", "id": 1, "typeArguments": [ { "type": "reference", "id": 4, "name": "Database" }, { "type": "reference", "id": 40, "name": "DynamicSchema" }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 40, "name": "DynamicSchema" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "extendsType": { "type": "reference", "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [2] }, { "title": "Properties", "kind": 1024, "children": [20, 18, 19, 17] }, { "title": "Methods", "kind": 2048, "children": [25, 42, 38] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 17, "character": 21 } ], "typeParameter": [ { "id": 53, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" }, "default": { "type": "intrinsic", "name": "any" } }, { "id": 54, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" }, "type": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } } ] }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } } ] } } }, { "id": 55, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 5, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "extendsType": { "type": "reference", "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 5, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ] }, { "id": 143, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 144, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 145, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 146, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 147, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 148, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 149, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 150, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 151, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 148, "name": "Result" } ], "name": "default", "dereferenced": { "id": 609, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", "flags": { "isAbstract": true }, "children": [ { "id": 610, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 20, "character": 2 } ], "signatures": [ { "id": 611, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 612, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 613, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default", "dereferenced": "[Circular ~.children.2.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default" } } ] }, { "id": 618, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 621, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 622, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 623, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 624, "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": 625, "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": 616, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 626, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 18, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 614, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 617, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 619, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 620, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } }, { "id": 615, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 629, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 50, "character": 2 } ], "signatures": [ { "id": 630, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 631, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 632, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 633, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 634, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 635, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 636, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 474, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 637, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 638, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 639, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 640, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "id": 475, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "implementationOf": { "type": "reference", "name": "PromiseLike.then" } } ], "implementationOf": { "type": "reference", "name": "PromiseLike.then" } }, { "id": 627, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 45, "character": 2 } ], "signatures": [ { "id": 628, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [610] }, { "title": "Properties", "kind": 1024, "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] }, { "title": "Methods", "kind": 2048, "children": [629, 627] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 7, "character": 30 } ], "typeParameter": [ { "id": 641, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedBy": [ { "type": "reference", "id": 489, "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 491, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", "id": 490, "name": "default.constructor" } }, { "id": 461, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" }, "inheritedFrom": { "type": "reference", "id": 581, "name": "default.body" } }, { "id": 464, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 465, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 466, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 467, "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": 468, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } }, "inheritedFrom": { "type": "reference", "id": 584, "name": "default.fetch" } }, { "id": 459, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, "inheritedFrom": { "type": "reference", "id": 579, "name": "default.headers" } }, { "id": 469, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 18, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 589, "name": "default.isMaybeSingle" } }, { "id": 457, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 577, "name": "default.method" } }, { "id": 460, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 580, "name": "default.schema" } }, { "id": 462, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false", "inheritedFrom": { "type": "reference", "id": 582, "name": "default.shouldThrowOnError" } }, { "id": 463, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 583, "name": "default.signal" } }, { "id": 458, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 578, "name": "default.url" } }, { "id": 429, "name": "abortSignal", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 180, "character": 2 } ], "signatures": [ { "id": 430, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { "id": 431, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The AbortSignal to use for the fetch request\n" }, "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 550, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", "id": 549, "name": "default.abortSignal" } }, { "id": 273, "name": "containedBy", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 281, "character": 2 } ], "signatures": [ { "id": 274, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." }, "typeParameter": [ { "id": 275, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 276, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", "id": 275, "name": "ColumnName", "dereferenced": {} } }, { "id": 277, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 275, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 278, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." }, "parameters": [ { "id": 279, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 280, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 265, "name": "contains", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 266, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." }, "typeParameter": [ { "id": 267, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 268, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", "id": 267, "name": "ColumnName", "dereferenced": {} } }, { "id": 269, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 267, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 270, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." }, "parameters": [ { "id": 271, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 272, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 438, "name": "csv", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 221, "character": 2 } ], "signatures": [ { "id": 439, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 559, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", "id": 558, "name": "default.csv" } }, { "id": 152, "name": "eq", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 35, "character": 2 } ], "signatures": [ { "id": 153, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is equal to `value`.", "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" }, "typeParameter": [ { "id": 154, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 155, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 154, "name": "ColumnName", "dereferenced": {} } }, { "id": 156, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 154, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } ], "qualifiedName": "NonNullable", "package": "typescript", "name": "NonNullable" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 157, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is equal to `value`.", "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" }, "typeParameter": [ { "id": 158, "name": "Value", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 159, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 160, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 158, "name": "Value" } ], "qualifiedName": "NonNullable", "package": "typescript", "name": "NonNullable" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 442, "name": "explain", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 259, "character": 2 } ], "signatures": [ { "id": 443, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as the EXPLAIN plan for the query.", "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" }, "parameters": [ { "id": 444, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 445, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 446, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 267, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 449, "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on buffer usage\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 270, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 451, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 272, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "text" }, { "type": "literal", "value": "json" } ] } }, { "id": 448, "name": "settings", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 269, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 447, "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 268, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 450, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on WAL record generation\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 271, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [446, 449, 451, 448, 447, 450] } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 609, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" }, { "type": "reference", "id": 609, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "name": "default" } ] }, "inheritedFrom": { "type": "reference", "id": 563, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", "id": 562, "name": "default.explain" } }, { "id": 368, "name": "filter", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 508, "character": 2 } ], "signatures": [ { "id": 369, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { "id": 370, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 371, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 370, "name": "ColumnName", "dereferenced": {} } }, { "id": 372, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to filter with, following PostgREST syntax" }, "type": { "type": "union", "types": [ { "type": "reference", "name": "FilterOperator" }, { "type": "literal", "value": "not.eq" }, { "type": "literal", "value": "not.neq" }, { "type": "literal", "value": "not.gt" }, { "type": "literal", "value": "not.gte" }, { "type": "literal", "value": "not.lt" }, { "type": "literal", "value": "not.lte" }, { "type": "literal", "value": "not.like" }, { "type": "literal", "value": "not.ilike" }, { "type": "literal", "value": "not.is" }, { "type": "literal", "value": "not.in" }, { "type": "literal", "value": "not.cs" }, { "type": "literal", "value": "not.cd" }, { "type": "literal", "value": "not.sl" }, { "type": "literal", "value": "not.sr" }, { "type": "literal", "value": "not.nxl" }, { "type": "literal", "value": "not.nxr" }, { "type": "literal", "value": "not.adj" }, { "type": "literal", "value": "not.ov" }, { "type": "literal", "value": "not.fts" }, { "type": "literal", "value": "not.plfts" }, { "type": "literal", "value": "not.phfts" }, { "type": "literal", "value": "not.wfts" } ] } }, { "id": 373, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 374, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "parameters": [ { "id": 375, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 376, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to filter with, following PostgREST syntax" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 377, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 440, "name": "geojson", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 229, "character": 2 } ], "signatures": [ { "id": 441, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 561, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", "id": 560, "name": "default.geojson" } }, { "id": 169, "name": "gt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 66, "character": 2 } ], "signatures": [ { "id": 170, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than `value`." }, "typeParameter": [ { "id": 171, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 172, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 171, "name": "ColumnName", "dereferenced": {} } }, { "id": 173, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 171, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 174, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than `value`." }, "parameters": [ { "id": 175, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 176, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 177, "name": "gte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 79, "character": 2 } ], "signatures": [ { "id": 178, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than or equal to `value`." }, "typeParameter": [ { "id": 179, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 180, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 179, "name": "ColumnName", "dereferenced": {} } }, { "id": 181, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 179, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 182, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than or equal to `value`." }, "parameters": [ { "id": 183, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 184, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 225, "name": "ilike", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 163, "character": 2 } ], "signatures": [ { "id": 226, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ { "id": 227, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 228, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 227, "name": "ColumnName", "dereferenced": {} } }, { "id": 229, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 230, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "parameters": [ { "id": 231, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 232, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 233, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 176, "character": 2 } ], "signatures": [ { "id": 234, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "typeParameter": [ { "id": 235, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 236, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 235, "name": "ColumnName", "dereferenced": {} } }, { "id": 237, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 238, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "parameters": [ { "id": 239, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 240, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 241, "name": "ilikeAnyOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 192, "character": 2 } ], "signatures": [ { "id": 242, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." }, "typeParameter": [ { "id": 243, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 244, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 243, "name": "ColumnName", "dereferenced": {} } }, { "id": 245, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 246, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." }, "parameters": [ { "id": 247, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 248, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 257, "name": "in", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 230, "character": 2 } ], "signatures": [ { "id": 258, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is included in the `values` array." }, "typeParameter": [ { "id": 259, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 260, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 259, "name": "ColumnName", "dereferenced": {} } }, { "id": 261, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values array to filter with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 259, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 262, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is included in the `values` array." }, "parameters": [ { "id": 263, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 264, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values array to filter with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 249, "name": "is", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 208, "character": 2 } ], "signatures": [ { "id": 250, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` IS `value`.", "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" }, "typeParameter": [ { "id": 251, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 252, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 251, "name": "ColumnName", "dereferenced": {} } }, { "id": 253, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intersection", "types": [ { "type": "intersection", "types": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 251, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } }, { "type": "literal", "value": null } ] }, { "type": "intersection", "types": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 251, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } }, { "type": "literal", "value": false } ] }, { "type": "intersection", "types": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 251, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } }, { "type": "literal", "value": true } ] } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 254, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` IS `value`.", "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" }, "parameters": [ { "id": 255, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 256, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 201, "name": "like", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 118, "character": 2 } ], "signatures": [ { "id": 202, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-sensitively." }, "typeParameter": [ { "id": 203, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 204, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 203, "name": "ColumnName", "dereferenced": {} } }, { "id": 205, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 206, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-sensitively." }, "parameters": [ { "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 208, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 209, "name": "likeAllOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 131, "character": 2 } ], "signatures": [ { "id": 210, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." }, "typeParameter": [ { "id": 211, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 212, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 211, "name": "ColumnName", "dereferenced": {} } }, { "id": 213, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 214, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." }, "parameters": [ { "id": 215, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 216, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 217, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 147, "character": 2 } ], "signatures": [ { "id": 218, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." }, "typeParameter": [ { "id": 219, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 220, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 219, "name": "ColumnName", "dereferenced": {} } }, { "id": 221, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 222, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." }, "parameters": [ { "id": 223, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 414, "name": "limit", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 131, "character": 2 } ], "signatures": [ { "id": 415, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by `count`." }, "parameters": [ { "id": 416, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 417, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 418, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 419, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [419, 420] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 535, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", "id": 534, "name": "default.limit" } }, { "id": 185, "name": "lt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 92, "character": 2 } ], "signatures": [ { "id": 186, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than `value`." }, "typeParameter": [ { "id": 187, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 188, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 187, "name": "ColumnName", "dereferenced": {} } }, { "id": 189, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 187, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 190, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than `value`." }, "parameters": [ { "id": 191, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 192, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 193, "name": "lte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 105, "character": 2 } ], "signatures": [ { "id": 194, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than or equal to `value`." }, "typeParameter": [ { "id": 195, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 196, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 195, "name": "ColumnName", "dereferenced": {} } }, { "id": 197, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 195, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 198, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than or equal to `value`." }, "parameters": [ { "id": 199, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 200, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 345, "name": "match", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 441, "character": 2 } ], "signatures": [ { "id": 346, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." }, "typeParameter": [ { "id": 347, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 348, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 347, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", "id": 347, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 349, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." }, "parameters": [ { "id": 350, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 435, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 204, "character": 2 } ], "signatures": [ { "id": 436, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "typeParameter": [ { "id": 437, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 148, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 437, "name": "ResultOne" } ] } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 556, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", "id": 555, "name": "default.maybeSingle" } }, { "id": 161, "name": "neq", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 53, "character": 2 } ], "signatures": [ { "id": 162, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is not equal to `value`." }, "typeParameter": [ { "id": 163, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 164, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 163, "name": "ColumnName", "dereferenced": {} } }, { "id": 165, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 163, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 166, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is not equal to `value`." }, "parameters": [ { "id": 167, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 168, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 351, "name": "not", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 457, "character": 2 } ], "signatures": [ { "id": 352, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which doesn't satisfy the filter.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { "id": 353, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 354, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 353, "name": "ColumnName", "dereferenced": {} } }, { "id": 355, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" }, "type": { "type": "reference", "name": "FilterOperator" } }, { "id": 356, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 353, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 357, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which doesn't satisfy the filter.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "parameters": [ { "id": 358, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 359, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 360, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 361, "name": "or", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 496, "character": 2 } ], "signatures": [ { "id": 362, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which satisfy at least one of the filters.", "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" }, "parameters": [ { "id": 363, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The filters to use, following PostgREST syntax" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 364, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 366, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `referencedTable` instead\n" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 501, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 367, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to filter on referenced tables\ninstead of the parent table" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 501, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [366, 367] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 383, "name": "order", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 55, "character": 2 } ], "signatures": [ { "id": 384, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ { "id": 385, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 386, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 385, "name": "ColumnName", "dereferenced": {} } }, { "id": 387, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 388, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 389, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 390, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 391, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [389, 390, 391] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 504, "name": "default.order" } }, { "id": 392, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "parameters": [ { "id": 393, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 394, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 395, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 396, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 397, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 398, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [396, 397, 398] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 512, "name": "default.order" } }, { "id": 399, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "typeParameter": [ { "id": 400, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 401, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 400, "name": "ColumnName", "dereferenced": {} } }, { "id": 402, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 403, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 404, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 406, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 405, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [404, 406, 405] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 519, "name": "default.order" } }, { "id": 407, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "parameters": [ { "id": 408, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 409, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 411, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 413, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 412, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [411, 413, 412] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 527, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", "id": 503, "name": "default.order" } }, { "id": 321, "name": "overlaps", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 380, "character": 2 } ], "signatures": [ { "id": 322, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." }, "typeParameter": [ { "id": 323, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 324, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range column to filter on" }, "type": { "type": "reference", "id": 323, "name": "ColumnName", "dereferenced": {} } }, { "id": 325, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 323, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 147, "name": "Row" } } } } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 326, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." }, "parameters": [ { "id": 327, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 328, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } } ] } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 421, "name": "range", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 158, "character": 2 } ], "signatures": [ { "id": 422, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + to`).\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { "id": 423, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The starting index from which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 424, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 425, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 426, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 427, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 428, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [427, 428] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 542, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", "id": 541, "name": "default.range" } }, { "id": 313, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 365, "character": 2 } ], "signatures": [ { "id": 314, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." }, "typeParameter": [ { "id": 315, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 316, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 315, "name": "ColumnName", "dereferenced": {} } }, { "id": 317, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 318, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." }, "parameters": [ { "id": 319, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 320, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 281, "name": "rangeGt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 307, "character": 2 } ], "signatures": [ { "id": 282, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." }, "typeParameter": [ { "id": 283, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 284, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 283, "name": "ColumnName", "dereferenced": {} } }, { "id": 285, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 286, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." }, "parameters": [ { "id": 287, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 288, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 289, "name": "rangeGte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 321, "character": 2 } ], "signatures": [ { "id": 290, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." }, "typeParameter": [ { "id": 291, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 292, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 291, "name": "ColumnName", "dereferenced": {} } }, { "id": 293, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 294, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." }, "parameters": [ { "id": 295, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 296, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 297, "name": "rangeLt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 336, "character": 2 } ], "signatures": [ { "id": 298, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." }, "typeParameter": [ { "id": 299, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 300, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 299, "name": "ColumnName", "dereferenced": {} } }, { "id": 301, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 302, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." }, "parameters": [ { "id": 303, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 304, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 305, "name": "rangeLte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 350, "character": 2 } ], "signatures": [ { "id": 306, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." }, "typeParameter": [ { "id": 307, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 308, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 307, "name": "ColumnName", "dereferenced": {} } }, { "id": 309, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 310, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." }, "parameters": [ { "id": 311, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 312, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 454, "name": "returns", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 311, "character": 2 } ], "signatures": [ { "id": 455, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Override the type of the returned `data`." }, "typeParameter": [ { "id": 456, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "The new result type to override with\n" } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 456, "name": "NewResult" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 575, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", "id": 574, "name": "default.returns" } }, { "id": 452, "name": "rollback", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 297, "character": 2 } ], "signatures": [ { "id": 453, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Rollback the query.", "text": "`data` will still be returned, but the query is not committed.\n" }, "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 573, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", "id": 572, "name": "default.rollback" } }, { "id": 378, "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 21, "character": 2 } ], "signatures": [ { "id": 379, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a SELECT on the query result.", "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { "id": 380, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 381, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" }, { "type": "reference", "id": 380, "name": "Query" } ], "name": "GetResult" } } ], "parameters": [ { "id": 382, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", "id": 380, "name": "Query", "dereferenced": {} } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", "id": 381, "name": "NewResultOne" } }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 499, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", "id": 498, "name": "default.select" } }, { "id": 432, "name": "single", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 191, "character": 2 } ], "signatures": [ { "id": 433, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "typeParameter": [ { "id": 434, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 148, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 434, "name": "ResultOne" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 553, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", "id": 552, "name": "default.single" } }, { "id": 329, "name": "textSearch", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 403, "character": 2 } ], "signatures": [ { "id": 330, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." }, "typeParameter": [ { "id": 331, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 332, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The text or tsvector column to filter on" }, "type": { "type": "reference", "id": 331, "name": "ColumnName", "dereferenced": {} } }, { "id": 333, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The query text to match with" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 334, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 335, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 336, "name": "config", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The text search configuration to use" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 406, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 337, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Change how the `query` text is interpreted\n" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 406, "character": 33 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "plain" }, { "type": "literal", "value": "phrase" }, { "type": "literal", "value": "websearch" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [336, 337] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } }, { "id": 338, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." }, "parameters": [ { "id": 339, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The text or tsvector column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 340, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The query text to match with" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 341, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 342, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 343, "name": "config", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The text search configuration to use" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 411, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 344, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Change how the `query` text is interpreted\n" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 411, "character": 33 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "plain" }, { "type": "literal", "value": "phrase" }, { "type": "literal", "value": "websearch" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [343, 344] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 472, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 50, "character": 2 } ], "signatures": [ { "id": 473, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 474, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 148, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 475, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 476, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 477, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 478, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 479, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 148, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 474, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 480, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 481, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 482, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 483, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "id": 475, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 593, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", "id": 592, "name": "default.then" } }, { "id": 470, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 45, "character": 2 } ], "signatures": [ { "id": 471, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 591, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", "id": 590, "name": "default.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [144] }, { "title": "Properties", "kind": 1024, "children": [461, 464, 459, 469, 457, 460, 462, 463, 458] }, { "title": "Methods", "kind": 2048, "children": [ 429, 273, 265, 438, 152, 442, 368, 440, 169, 177, 225, 233, 241, 257, 249, 201, 209, 217, 414, 185, 193, 345, 435, 161, 351, 361, 383, 321, 421, 313, 281, 289, 297, 305, 454, 452, 378, 432, 329, 472, 470 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 28, "character": 21 } ], "typeParameter": [ { "id": 484, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 485, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 486, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 487, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 488, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "extendedTypes": [ { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 146, "name": "Schema" }, { "type": "reference", "id": 147, "name": "Row" }, { "type": "reference", "id": 148, "name": "Result" }, { "type": "reference", "id": 149, "name": "RelationName" }, { "type": "reference", "id": 150, "name": "Relationships" } ], "name": "default" } ] }, { "id": 56, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 57, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 18, "character": 2 } ], "signatures": [ { "id": 58, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 59, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 60, "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "GenericTable" }, { "type": "reference", "name": "GenericView" } ] } }, { "id": 61, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 64, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 60, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { "id": 62, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 63, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "reference", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [63] } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } } ], "parameters": [ { "id": 65, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 66, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 67, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 70, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 27, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 71, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 72, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 73, "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": 74, "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": 68, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 25, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 69, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 26, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [70, 68, 69] } ] } } } ], "type": { "type": "reference", "id": 56, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "reference", "id": 60, "name": "Relation" }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 79, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 80, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 81, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 82, "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": 83, "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": 76, "name": "headers", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 13, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 77, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 14, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 78, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 15, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } }, { "id": 75, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 12, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 132, "name": "delete", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 357, "character": 2 } ], "signatures": [ { "id": 133, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a DELETE on the table or view.", "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "parameters": [ { "id": 134, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 135, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 136, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 360, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [136] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 93, "name": "insert", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 101, "character": 2 } ], "signatures": [ { "id": 94, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an INSERT into the table or view.", "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 95, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 96, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" }, "type": { "type": "reference", "id": 95, "name": "Row", "dereferenced": {} } }, { "id": 97, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 99, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 104, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [99] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } }, { "id": 100, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an INSERT into the table or view.", "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 101, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 102, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 101, "name": "Row" } } }, { "id": 103, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 104, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 105, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 110, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 106, "name": "defaultToNull", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. Only applies for bulk\ninserts.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 111, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [105, 106] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 84, "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 57, "character": 2 } ], "signatures": [ { "id": 85, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a SELECT query on the table or view." }, "typeParameter": [ { "id": 86, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 87, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" }, { "type": "reference", "id": 86, "name": "Query" } ], "name": "GetResult" } } ], "parameters": [ { "id": 88, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`\n" }, "type": { "type": "reference", "id": 86, "name": "Query", "dereferenced": {} } }, { "id": 89, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 90, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 92, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 67, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 91, "name": "head", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 66, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [92, 91] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "array", "elementType": { "type": "reference", "id": 87, "name": "ResultOne" } }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 125, "name": "update", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 309, "character": 2 } ], "signatures": [ { "id": 126, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an UPDATE on the table or view.", "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "typeParameter": [ { "id": 127, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 128, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to update with\n" }, "type": { "type": "reference", "id": 127, "name": "Row", "dereferenced": {} } }, { "id": 129, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 130, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 131, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 314, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [131] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 107, "name": "upsert", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 184, "character": 2 } ], "signatures": [ { "id": 108, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 109, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 110, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { "type": "reference", "id": 109, "name": "Row", "dereferenced": {} } }, { "id": 111, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 112, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 115, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 189, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 114, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 188, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 113, "name": "onConflict", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 187, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [115, 114, 113] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } }, { "id": 116, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 117, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 118, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 117, "name": "Row" } } }, { "id": 119, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 120, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 123, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 197, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 124, "name": "defaultToNull", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n`ignoreDuplicates: false`. This also only applies when doing bulk upserts.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 198, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 122, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 196, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 121, "name": "onConflict", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 195, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [123, 124, 122, 121] } ] } } } ], "type": { "type": "reference", "id": 143, "typeArguments": [ { "type": "reference", "id": 59, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 60, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 61, "name": "RelationName" }, { "type": "reference", "id": 64, "name": "Relationships" } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [57] }, { "title": "Properties", "kind": 1024, "children": [79, 76, 77, 78, 75] }, { "title": "Methods", "kind": 2048, "children": [132, 93, 84, 125, 107] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 6, "character": 21 } ], "typeParameter": [ { "id": 137, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 138, "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "GenericTable" }, { "type": "reference", "name": "GenericView" } ] } }, { "id": 139, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 142, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 60, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 141, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "inferred", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [141] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 35 } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } } ] }, { "id": 489, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 490, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 491, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 492, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 493, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 494, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 495, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 496, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 497, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 494, "name": "Result" } ], "name": "default", "dereferenced": { "id": 609, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", "flags": { "isAbstract": true }, "children": [ { "id": 610, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 20, "character": 2 } ], "signatures": [ { "id": 611, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 612, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 613, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default", "dereferenced": "[Circular ~.children.4.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default" } } ] }, { "id": 618, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 621, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 622, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 623, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 624, "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": 625, "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": 616, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 626, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 18, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 614, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 617, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 619, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 620, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } }, { "id": 615, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 629, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 50, "character": 2 } ], "signatures": [ { "id": 630, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 631, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 632, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 633, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 634, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 635, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 636, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 474, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 637, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 638, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 639, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 640, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "id": 475, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "implementationOf": { "type": "reference", "name": "PromiseLike.then" } } ], "implementationOf": { "type": "reference", "name": "PromiseLike.then" } }, { "id": 627, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 45, "character": 2 } ], "signatures": [ { "id": 628, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [610] }, { "title": "Properties", "kind": 1024, "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] }, { "title": "Methods", "kind": 2048, "children": [629, 627] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 7, "character": 30 } ], "typeParameter": [ { "id": 641, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedBy": [ { "type": "reference", "id": 489, "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 612, "name": "Result" } ], "name": "PostgrestSingleResponse" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 611, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", "id": 610, "name": "default.constructor" } }, { "id": 581, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" }, "inheritedFrom": { "type": "reference", "id": 618, "name": "default.body" } }, { "id": 584, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 586, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 587, "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": 588, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } }, "inheritedFrom": { "type": "reference", "id": 621, "name": "default.fetch" } }, { "id": 579, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, "inheritedFrom": { "type": "reference", "id": 616, "name": "default.headers" } }, { "id": 589, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 18, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 626, "name": "default.isMaybeSingle" } }, { "id": 577, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 614, "name": "default.method" } }, { "id": 580, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 617, "name": "default.schema" } }, { "id": 582, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false", "inheritedFrom": { "type": "reference", "id": 619, "name": "default.shouldThrowOnError" } }, { "id": 583, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 620, "name": "default.signal" } }, { "id": 578, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 615, "name": "default.url" } }, { "id": 549, "name": "abortSignal", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 180, "character": 2 } ], "signatures": [ { "id": 550, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { "id": 551, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The AbortSignal to use for the fetch request\n" }, "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 558, "name": "csv", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 221, "character": 2 } ], "signatures": [ { "id": 559, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" } } ] }, { "id": 562, "name": "explain", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 259, "character": 2 } ], "signatures": [ { "id": 563, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as the EXPLAIN plan for the query.", "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" }, "parameters": [ { "id": 564, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 565, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 566, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 267, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 569, "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on buffer usage\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 270, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 571, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 272, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "text" }, { "type": "literal", "value": "json" } ] } }, { "id": 568, "name": "settings", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 269, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 567, "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 268, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 570, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on WAL record generation\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 271, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [566, 569, 571, 568, 567, 570] } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 609, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" }, { "type": "reference", "id": 609, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "name": "default" } ] } } ] }, { "id": 560, "name": "geojson", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 229, "character": 2 } ], "signatures": [ { "id": 561, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ], "name": "default" } } ] }, { "id": 534, "name": "limit", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 131, "character": 2 } ], "signatures": [ { "id": 535, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by `count`." }, "parameters": [ { "id": 536, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 537, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 538, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 539, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 540, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [539, 540] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 555, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 204, "character": 2 } ], "signatures": [ { "id": 556, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "typeParameter": [ { "id": 557, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 494, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 437, "name": "ResultOne" } ] } ], "name": "default" } } ] }, { "id": 503, "name": "order", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 55, "character": 2 } ], "signatures": [ { "id": 504, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ { "id": 505, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 506, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 385, "name": "ColumnName", "dereferenced": {} } }, { "id": 507, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 508, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 509, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 510, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 511, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [509, 510, 511] } ] } } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } }, { "id": 512, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "parameters": [ { "id": 513, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 516, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 517, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 518, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [516, 517, 518] } ] } } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } }, { "id": 519, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "typeParameter": [ { "id": 520, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 521, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 400, "name": "ColumnName", "dereferenced": {} } }, { "id": 522, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 524, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 526, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 525, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [524, 526, 525] } ] } } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } }, { "id": 527, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "parameters": [ { "id": 528, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 529, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 531, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 533, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 532, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [531, 533, 532] } ] } } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 541, "name": "range", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 158, "character": 2 } ], "signatures": [ { "id": 542, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + to`).\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { "id": 543, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The starting index from which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 544, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 545, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 546, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 547, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 548, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [547, 548] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 574, "name": "returns", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 311, "character": 2 } ], "signatures": [ { "id": 575, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Override the type of the returned `data`." }, "typeParameter": [ { "id": 576, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "The new result type to override with\n" } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 456, "name": "NewResult" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 572, "name": "rollback", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 297, "character": 2 } ], "signatures": [ { "id": 573, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Rollback the query.", "text": "`data` will still be returned, but the query is not committed.\n" }, "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 498, "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 21, "character": 2 } ], "signatures": [ { "id": 499, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a SELECT on the query result.", "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { "id": 500, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 501, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" }, { "type": "reference", "id": 380, "name": "Query" } ], "name": "GetResult" } } ], "parameters": [ { "id": 502, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", "id": 380, "name": "Query", "dereferenced": {} } } ], "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", "id": 381, "name": "NewResultOne" } }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 552, "name": "single", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 191, "character": 2 } ], "signatures": [ { "id": 553, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "typeParameter": [ { "id": 554, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 494, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 434, "name": "ResultOne" } ], "name": "default" } } ] }, { "id": 592, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 50, "character": 2 } ], "signatures": [ { "id": 593, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 594, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 494, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 595, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 596, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 597, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 598, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 599, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 657, "typeArguments": [ { "type": "reference", "id": 494, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 474, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 600, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 601, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 602, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 603, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 474, "name": "TResult1" }, { "type": "reference", "id": 475, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 630, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", "id": 629, "name": "default.then" } }, { "id": 590, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 45, "character": 2 } ], "signatures": [ { "id": 591, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 489, "typeArguments": [ { "type": "reference", "id": 492, "name": "Schema" }, { "type": "reference", "id": 493, "name": "Row" }, { "type": "reference", "id": 494, "name": "Result" }, { "type": "reference", "id": 495, "name": "RelationName" }, { "type": "reference", "id": 496, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 628, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", "id": 627, "name": "default.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [490] }, { "title": "Properties", "kind": 1024, "children": [581, 584, 579, 589, 577, 580, 582, 583, 578] }, { "title": "Methods", "kind": 2048, "children": [549, 558, 562, 560, 534, 555, 503, 541, 574, 572, 498, 552, 592, 590] } ], "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 5, "character": 21 } ], "typeParameter": [ { "id": 604, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 605, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 606, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 607, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 608, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "extendedTypes": [ { "type": "reference", "id": 609, "typeArguments": [ { "type": "reference", "id": 494, "name": "Result" } ], "name": "default" } ], "extendedBy": [ { "type": "reference", "id": 143, "name": "PostgrestFilterBuilder" } ] }, { "id": 644, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 647, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 32, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 646, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 31, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 645, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 30, "character": 2 } ], "type": { "type": "reference", "id": 661, "name": "PostgrestError", "dereferenced": { "id": 661, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 662, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 666, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 12, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 664, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 10, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 665, "name": "hint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 11, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 663, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 9, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [666, 664, 665, 663] } ], "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 29 } ] } } } } }, { "id": 648, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 21, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.status" } }, { "id": 649, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [647, 646, 645, 648, 649] } ], "sources": [ { "fileName": "src/types.ts", "line": 29, "character": 17 } ], "extendedTypes": [ { "type": "reference", "name": "PostgrestResponseBase" } ] }, { "id": 650, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 653, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 27, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 652, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "id": 656, "name": "T", "dereferenced": {} } }, { "id": 651, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 25, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 654, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 21, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.status" } }, { "id": 655, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [653, 652, 651, 654, 655] } ], "sources": [ { "fileName": "src/types.ts", "line": 24, "character": 17 } ], "typeParameter": [ { "id": 656, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedTypes": [ { "type": "reference", "name": "PostgrestResponseBase" } ] }, { "id": 661, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 662, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 666, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 12, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 664, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 10, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 665, "name": "hint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 11, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 663, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 9, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [666, 664, 665, 663] } ], "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 29 } ] } } }, { "id": 659, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 39, "character": 12 } ], "typeParameter": [ { "id": 660, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reference", "id": 657, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 660, "name": "T" }, { "type": "literal", "value": null } ] } ], "name": "PostgrestSingleResponse" } }, { "id": 642, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 40, "character": 12 } ], "typeParameter": [ { "id": 643, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reference", "id": 657, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 643, "name": "T" } } ], "name": "PostgrestSingleResponse" } }, { "id": 657, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 38, "character": 12 } ], "typeParameter": [ { "id": 658, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "union", "types": [ { "id": 650, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 653, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 27, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 652, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "id": 656, "name": "T", "dereferenced": {} } }, { "id": 651, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 25, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 654, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 21, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.status" } }, { "id": 655, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [653, 652, 651, 654, 655] } ], "sources": [ { "fileName": "src/types.ts", "line": 24, "character": 17 } ], "typeParameter": [ { "id": 656, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedTypes": [ { "type": "reference", "name": "PostgrestResponseBase" } ] }, { "id": 644, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 647, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 32, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 646, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 31, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 645, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 30, "character": 2 } ], "type": { "type": "reference", "id": 661, "name": "PostgrestError", "dereferenced": { "id": 661, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 662, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 666, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 12, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 664, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 10, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 665, "name": "hint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 11, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 663, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 9, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [666, 664, 665, 663] } ], "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 29 } ] } } } } }, { "id": 648, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 21, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.status" } }, { "id": 649, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [647, 646, 645, 648, 649] } ], "sources": [ { "fileName": "src/types.ts", "line": 29, "character": 17 } ], "extendedTypes": [ { "type": "reference", "name": "PostgrestResponseBase" } ] } ] } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [609, 1, 143, 56, 489] }, { "title": "Interfaces", "kind": 256, "children": [644, 650] }, { "title": "Type Aliases", "kind": 4194304, "children": [661, 659, 642, 657] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 0, "name": "@supabase/realtime-js", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 588, "name": "REALTIME_LISTEN_TYPES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 589, "name": "BROADCAST", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 93, "character": 2 } ], "type": { "type": "literal", "value": "broadcast" }, "defaultValue": "\"broadcast\"" }, { "id": 591, "name": "POSTGRES_CHANGES", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "comment": { "shortText": "listen to Postgres changes." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 98, "character": 2 } ], "type": { "type": "literal", "value": "postgres_changes" }, "defaultValue": "\"postgres_changes\"" }, { "id": 590, "name": "PRESENCE", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 94, "character": 2 } ], "type": { "type": "literal", "value": "presence" }, "defaultValue": "\"presence\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [589, 591, 590] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 92, "character": 12 } ] }, { "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 593, "name": "ALL", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 86, "character": 2 } ], "type": { "type": "literal", "value": "*" }, "defaultValue": "\"*\"" }, { "id": 596, "name": "DELETE", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 89, "character": 2 } ], "type": { "type": "literal", "value": "DELETE" }, "defaultValue": "\"DELETE\"" }, { "id": 594, "name": "INSERT", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 87, "character": 2 } ], "type": { "type": "literal", "value": "INSERT" }, "defaultValue": "\"INSERT\"" }, { "id": 595, "name": "UPDATE", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 88, "character": 2 } ], "type": { "type": "literal", "value": "UPDATE" }, "defaultValue": "\"UPDATE\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [593, 596, 594, 595] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 85, "character": 12 } ] }, { "id": 597, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 599, "name": "JOIN", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 37, "character": 2 } ], "type": { "type": "literal", "value": "join" }, "defaultValue": "\"join\"" }, { "id": 600, "name": "LEAVE", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 38, "character": 2 } ], "type": { "type": "literal", "value": "leave" }, "defaultValue": "\"leave\"" }, { "id": 598, "name": "SYNC", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 36, "character": 2 } ], "type": { "type": "literal", "value": "sync" }, "defaultValue": "\"sync\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [599, 600, 598] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 35, "character": 12 } ] }, { "id": 601, "name": "REALTIME_SUBSCRIBE_STATES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 605, "name": "CHANNEL_ERROR", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 105, "character": 2 } ], "type": { "type": "literal", "value": "CHANNEL_ERROR" }, "defaultValue": "\"CHANNEL_ERROR\"" }, { "id": 604, "name": "CLOSED", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 104, "character": 2 } ], "type": { "type": "literal", "value": "CLOSED" }, "defaultValue": "\"CLOSED\"" }, { "id": 602, "name": "SUBSCRIBED", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 102, "character": 2 } ], "type": { "type": "literal", "value": "SUBSCRIBED" }, "defaultValue": "\"SUBSCRIBED\"" }, { "id": 603, "name": "TIMED_OUT", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 103, "character": 2 } ], "type": { "type": "literal", "value": "TIMED_OUT" }, "defaultValue": "\"TIMED_OUT\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [605, 604, 602, 603] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 101, "character": 12 } ] }, { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": [ { "id": 75, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 134, "character": 2 } ], "signatures": [ { "id": 76, "name": "new RealtimeChannel", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 77, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 78, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 79, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 360, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 112, "character": 2 } ], "signatures": [ { "id": 361, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 362, "name": "endPoint", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 491, "name": "RealtimeClientOptions", "dereferenced": { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 359, "name": "default" } } ] }, { "id": 364, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 365, "name": "apiKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 366, "name": "channels", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 67, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } }, "defaultValue": "[]" }, { "id": 387, "name": "conn", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 82, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLike" } ] }, "defaultValue": "null" }, { "id": 385, "name": "decode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 384, "name": "encode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 79, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 367, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" }, { "id": 396, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 96, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 398, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 399, "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": 400, "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": 401, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 402, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "Request", "package": "typescript", "name": "Request" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 403, "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": 368, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 69, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 370, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 371, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 378, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 379, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 74, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "qualifiedName": "global.NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } ] }, "defaultValue": "undefined" }, { "id": 383, "name": "logger", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 78, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "noop" }, { "id": 372, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 70, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 374, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 375, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 380, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 75, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 386, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 81, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 382, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 77, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 381, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 388, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 83, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, "defaultValue": "[]" }, { "id": 389, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 84, "character": 2 } ], "type": { "type": "reference", "name": "default" }, "defaultValue": "..." }, { "id": 390, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 85, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 393, "name": "close", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 87, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 394, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 88, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 395, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 89, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 392, "name": "open", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 86, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [393, 394, 395, 392] } ] } }, "defaultValue": "..." }, { "id": 376, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 377, "name": "transport", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLikeConstructor" } ] } }, { "id": 426, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 274, "character": 2 } ], "signatures": [ { "id": 427, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 404, "name": "connect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 405, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 422, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 423, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "name": "CONNECTION_STATE" } } ] }, { "id": 406, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 195, "character": 2 } ], "signatures": [ { "id": 407, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 408, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A numeric status code to send on disconnect." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 409, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A custom reason for the disconnect.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 410, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 213, "character": 2 } ], "signatures": [ { "id": 411, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all created channels" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } } } ] }, { "id": 424, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 270, "character": 2 } ], "signatures": [ { "id": 425, "name": "isConnected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns `true` is the connection is open." }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 417, "name": "log", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 247, "character": 2 } ], "signatures": [ { "id": 418, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overridden.\n" }, "parameters": [ { "id": 419, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 430, "name": "push", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 288, "character": 2 } ], "signatures": [ { "id": 431, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 432, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 510, "name": "RealtimeMessage", "dereferenced": { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 516, 514, 515, 512] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 415, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 234, "character": 8 } ], "signatures": [ { "id": 416, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all channels" }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 412, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 413, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes a single channel" }, "parameters": [ { "id": 414, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A RealtimeChannel instance\n" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": "[Circular ~.children.4.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [ 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 ] }, { "title": "Methods", "kind": 2048, "children": [ 269, 135, 112, 245, 104, 119, 264, 129, 258 ] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 433, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 308, "character": 2 } ], "signatures": [ { "id": 434, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 435, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 80, "name": "bindings", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 116, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 82, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 83, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 90, "name": "callback", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 120, "character": 6 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 86, "name": "filter", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 14 } ], "indexSignature": { "id": 88, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 89, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 91, "name": "id", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 121, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 85, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 118, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [90, 86, 91, 85] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 117, "character": 19 } ] } } } } } }, "defaultValue": "{}" }, { "id": 99, "name": "broadcastEndpointURL", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 131, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 95, "name": "joinPush", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 127, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 94, "name": "joinedOnce", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 126, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 102, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 98, "name": "presence", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 130, "character": 2 } ], "type": { "type": "reference", "id": 1, "name": "default", "dereferenced": { "id": 1, "name": "RealtimePresence", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 36, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 84, "character": 2 } ], "signatures": [ { "id": 37, "name": "new RealtimePresence", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Presence." }, "parameters": [ { "id": 38, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The RealtimeChannel" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": "[Circular ~.children.4.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [ 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 ] }, { "title": "Methods", "kind": 2048, "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] } } }, { "id": 39, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" }, "type": { "type": "reference", "qualifiedName": "PresenceOpts", "package": "@types/phoenix", "name": "PresenceOpts" } } ], "type": { "type": "reference", "id": 1, "name": "default" } } ] }, { "id": 44, "name": "caller", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 67, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 45, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 46, "name": "onJoin", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 68, "character": 4 } ], "type": { "type": "reference", "qualifiedName": "PresenceOnJoinCallback", "package": "@types/phoenix", "name": "PresenceOnJoinCallback" } }, { "id": 47, "name": "onLeave", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 69, "character": 4 } ], "type": { "type": "reference", "qualifiedName": "PresenceOnLeaveCallback", "package": "@types/phoenix", "name": "PresenceOnLeaveCallback" } }, { "id": 48, "name": "onSync", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 70, "character": 4 } ], "signatures": [ { "id": 49, "name": "onSync", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [46, 47] }, { "title": "Methods", "kind": 2048, "children": [48] } ] } }, "defaultValue": "..." }, { "id": 50, "name": "channel", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": "[Circular ~.children.4.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] }, { "title": "Methods", "kind": 2048, "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] } } }, { "id": 43, "name": "joinRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 42, "name": "pendingDiffs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 65, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "RawPresenceDiff" } }, "defaultValue": "[]" }, { "id": 40, "name": "state", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 64, "character": 2 } ], "type": { "type": "reference", "id": 578, "typeArguments": [ { "type": "reflection", "declaration": { "id": 41, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } ], "name": "RealtimePresenceState", "dereferenced": { "id": 578, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 12 } ], "typeParameter": [ { "id": 586, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 582, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 44 } ], "indexSignature": { "id": 583, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 584, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 69 } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 579, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 75 } ], "indexSignature": { "id": 580, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 581, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 586, "name": "T" } ], "name": "Presence" } } } } } } }, "defaultValue": "{}" } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [36] }, { "title": "Properties", "kind": 1024, "children": [44, 50, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, "character": 21 } ] } } }, { "id": 97, "name": "pushBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 129, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "default" } }, "defaultValue": "[]" }, { "id": 96, "name": "rejoinTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 128, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 103, "name": "socket", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 360, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 112, "character": 2 } ], "signatures": [ { "id": 361, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 362, "name": "endPoint", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 491, "name": "RealtimeClientOptions", "dereferenced": { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 359, "name": "default" } } ] }, { "id": 364, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 365, "name": "apiKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 366, "name": "channels", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 67, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } }, "defaultValue": "[]" }, { "id": 387, "name": "conn", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 82, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLike" } ] }, "defaultValue": "null" }, { "id": 385, "name": "decode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 384, "name": "encode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 79, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 367, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" }, { "id": 396, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 96, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 398, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 399, "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": 400, "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": 401, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 402, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "Request", "package": "typescript", "name": "Request" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 403, "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": 368, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 69, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 370, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 371, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 378, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 379, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 74, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "qualifiedName": "global.NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } ] }, "defaultValue": "undefined" }, { "id": 383, "name": "logger", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 78, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "noop" }, { "id": 372, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 70, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 374, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 375, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 380, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 75, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 386, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 81, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 382, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 77, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 381, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 388, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 83, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, "defaultValue": "[]" }, { "id": 389, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 84, "character": 2 } ], "type": { "type": "reference", "name": "default" }, "defaultValue": "..." }, { "id": 390, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 85, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 393, "name": "close", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 87, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 394, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 88, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 395, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 89, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 392, "name": "open", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 86, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [393, 394, 395, 392] } ] } }, "defaultValue": "..." }, { "id": 376, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 377, "name": "transport", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLikeConstructor" } ] } }, { "id": 426, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 274, "character": 2 } ], "signatures": [ { "id": 427, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 404, "name": "connect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 405, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 422, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 423, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "name": "CONNECTION_STATE" } } ] }, { "id": 406, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 195, "character": 2 } ], "signatures": [ { "id": 407, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 408, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A numeric status code to send on disconnect." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 409, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A custom reason for the disconnect.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 410, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 213, "character": 2 } ], "signatures": [ { "id": 411, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all created channels" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } } } ] }, { "id": 424, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 270, "character": 2 } ], "signatures": [ { "id": 425, "name": "isConnected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns `true` is the connection is open." }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 417, "name": "log", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 247, "character": 2 } ], "signatures": [ { "id": 418, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overridden.\n" }, "parameters": [ { "id": 419, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 430, "name": "push", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 288, "character": 2 } ], "signatures": [ { "id": 431, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 432, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 510, "name": "RealtimeMessage", "dereferenced": { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 516, 514, 515, 512] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 415, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 234, "character": 8 } ], "signatures": [ { "id": 416, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all channels" }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 412, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 413, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes a single channel" }, "parameters": [ { "id": 414, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A RealtimeChannel instance\n" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": "[Circular ~.children.4.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [ 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 ] }, { "title": "Methods", "kind": 2048, "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 433, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 308, "character": 2 } ], "signatures": [ { "id": 434, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 435, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } }, { "id": 93, "name": "state", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 125, "character": 2 } ], "type": { "type": "reference", "name": "CHANNEL_STATES" }, "defaultValue": "CHANNEL_STATES.closed" }, { "id": 100, "name": "subTopic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 132, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 92, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 124, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 101, "name": "topic", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 269, "name": "_fetchWithTimeout", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 538, "character": 8 } ], "signatures": [ { "id": 270, "name": "_fetchWithTimeout", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 271, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 272, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 274, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 275, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 276, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 135, "name": "on", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 350, "character": 2 } ], "signatures": [ { "id": 136, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates an event handler that listens to changes." }, "parameters": [ { "id": 137, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 138, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 139, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 140, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 352, "character": 14 } ], "type": { "type": "literal", "value": "sync" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [140] } ] } } }, { "id": 141, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 143, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 144, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 148, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 145, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 146, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 147, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 149, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 150, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 152, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 357, "character": 14 } ], "type": { "type": "literal", "value": "join" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [152] } ] } } }, { "id": 153, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 154, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 155, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 156, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 558, "typeArguments": [ { "type": "reference", "id": 148, "name": "T" } ], "name": "RealtimePresenceJoinPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 157, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 161, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 159, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 160, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 162, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 163, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 165, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 362, "character": 14 } ], "type": { "type": "literal", "value": "leave" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [165] } ] } } }, { "id": 166, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 167, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 168, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 169, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 568, "typeArguments": [ { "type": "reference", "id": 161, "name": "T" } ], "name": "RealtimePresenceLeavePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 170, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 174, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 172, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 173, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 175, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 176, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "*" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 177, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 179, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 180, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 524, "typeArguments": [ { "type": "reference", "id": 174, "name": "T" } ], "name": "RealtimePostgresChangesPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 181, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 185, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 183, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 184, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 186, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 187, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "INSERT" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 188, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 190, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 191, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 529, "typeArguments": [ { "type": "reference", "id": 185, "name": "T" } ], "name": "RealtimePostgresInsertPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 192, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 196, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 193, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 194, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 195, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 197, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 198, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "UPDATE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 199, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 200, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 201, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 202, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 539, "typeArguments": [ { "type": "reference", "id": 196, "name": "T" } ], "name": "RealtimePostgresUpdatePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 203, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 207, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 205, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 206, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 208, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 209, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "DELETE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 210, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 212, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 213, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 548, "typeArguments": [ { "type": "reference", "id": 207, "name": "T" } ], "name": "RealtimePostgresDeletePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 214, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." }, "parameters": [ { "id": 215, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." }, "type": { "type": "literal", "value": "broadcast" } }, { "id": 216, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." }, "type": { "type": "reflection", "declaration": { "id": 217, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 218, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 393, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [218] } ] } } }, { "id": 219, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Function to be invoked when event handler is triggered.\n" }, "type": { "type": "reflection", "declaration": { "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 221, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 222, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 223, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 225, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 396, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 395, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [225, 224] } ], "indexSignature": { "id": 226, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 227, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 228, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 232, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 230, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 231, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 233, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "broadcast" } }, { "id": 234, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 236, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 402, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [236] } ] } } }, { "id": 237, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 238, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 239, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 240, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 241, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 243, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 405, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 244, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 406, "character": 6 } ], "type": { "type": "reference", "id": 232, "name": "T" } }, { "id": 242, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 404, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [243, 244, 242] } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 112, "name": "presenceState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 315, "character": 2 } ], "signatures": [ { "id": 113, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 118, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 114, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 115, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 116, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 117, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } } ], "type": { "type": "reference", "id": 578, "typeArguments": [ { "type": "reference", "id": 118, "name": "T" } ], "name": "RealtimePresenceState" } } ] }, { "id": 245, "name": "send", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 425, "character": 8 } ], "signatures": [ { "id": 246, "name": "send", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a message into the channel." }, "parameters": [ { "id": 247, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Arguments to send to channel" }, "type": { "type": "reflection", "declaration": { "id": 248, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 250, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The name of the event being sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 428, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 251, "name": "payload", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Payload to be sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 429, "character": 6 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 249, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of event to send" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 427, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "presence" }, { "type": "literal", "value": "broadcast" }, { "type": "literal", "value": "postgres_changes" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [250, 251, 249] } ], "indexSignature": { "id": 252, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 253, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 254, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Options to be used during the send process\n" }, "type": { "type": "reflection", "declaration": { "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 256, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 257, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 104, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 198, "character": 2 } ], "signatures": [ { "id": 105, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Subscribe registers your client with the server" }, "parameters": [ { "id": 106, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 107, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 108, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 109, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "SUBSCRIBED" }, { "type": "literal", "value": "TIMED_OUT" }, { "type": "literal", "value": "CLOSED" }, { "type": "literal", "value": "CHANNEL_ERROR" } ] } }, { "id": 110, "name": "err", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } }, { "id": 111, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 119, "name": "track", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 321, "character": 8 } ], "signatures": [ { "id": 120, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 121, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 122, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 123, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 124, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 125, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 126, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 127, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 128, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 264, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 495, "character": 2 } ], "signatures": [ { "id": 265, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Leaves the channel.", "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" }, "parameters": [ { "id": 266, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "error" }, { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 129, "name": "untrack", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 335, "character": 8 } ], "signatures": [ { "id": 130, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 131, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 132, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 133, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 134, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 258, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 482, "character": 2 } ], "signatures": [ { "id": 259, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 260, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 262, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 263, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] }, { "title": "Methods", "kind": 2048, "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] }, { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 360, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 112, "character": 2 } ], "signatures": [ { "id": 361, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 362, "name": "endPoint", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 491, "name": "RealtimeClientOptions", "dereferenced": { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 359, "name": "default" } } ] }, { "id": 364, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 365, "name": "apiKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 366, "name": "channels", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 67, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } }, "defaultValue": "[]" }, { "id": 387, "name": "conn", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 82, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLike" } ] }, "defaultValue": "null" }, { "id": 385, "name": "decode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 384, "name": "encode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 79, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 367, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" }, { "id": 396, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 96, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 398, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 399, "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": 400, "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": 401, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 402, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "Request", "package": "typescript", "name": "Request" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 403, "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": 368, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 69, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 370, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 371, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 378, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 379, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 74, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "qualifiedName": "global.NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } ] }, "defaultValue": "undefined" }, { "id": 383, "name": "logger", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 78, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "noop" }, { "id": 372, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 70, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 374, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 375, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 380, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 75, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 386, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 81, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 382, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 77, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 381, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 388, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 83, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, "defaultValue": "[]" }, { "id": 389, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 84, "character": 2 } ], "type": { "type": "reference", "name": "default" }, "defaultValue": "..." }, { "id": 390, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 85, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 393, "name": "close", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 87, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 394, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 88, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 395, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 89, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 392, "name": "open", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 86, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [393, 394, 395, 392] } ] } }, "defaultValue": "..." }, { "id": 376, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 377, "name": "transport", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLikeConstructor" } ] } }, { "id": 426, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 274, "character": 2 } ], "signatures": [ { "id": 427, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 404, "name": "connect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 405, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 422, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 423, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "name": "CONNECTION_STATE" } } ] }, { "id": 406, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 195, "character": 2 } ], "signatures": [ { "id": 407, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 408, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A numeric status code to send on disconnect." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 409, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A custom reason for the disconnect.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 410, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 213, "character": 2 } ], "signatures": [ { "id": 411, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all created channels" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } } } ] }, { "id": 424, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 270, "character": 2 } ], "signatures": [ { "id": 425, "name": "isConnected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns `true` is the connection is open." }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 417, "name": "log", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 247, "character": 2 } ], "signatures": [ { "id": 418, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overridden.\n" }, "parameters": [ { "id": 419, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 430, "name": "push", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 288, "character": 2 } ], "signatures": [ { "id": 431, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 432, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 510, "name": "RealtimeMessage", "dereferenced": { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 516, 514, 515, 512] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 415, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 234, "character": 8 } ], "signatures": [ { "id": 416, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all channels" }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 412, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 413, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes a single channel" }, "parameters": [ { "id": 414, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A RealtimeChannel instance\n" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": [ { "id": 75, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 134, "character": 2 } ], "signatures": [ { "id": 76, "name": "new RealtimeChannel", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 77, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 78, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 79, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": "[Circular ~.children.5.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [ 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 80, "name": "bindings", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 116, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 82, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 83, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 90, "name": "callback", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 120, "character": 6 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 86, "name": "filter", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 14 } ], "indexSignature": { "id": 88, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 89, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 91, "name": "id", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 121, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 85, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 118, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [90, 86, 91, 85] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 117, "character": 19 } ] } } } } } }, "defaultValue": "{}" }, { "id": 99, "name": "broadcastEndpointURL", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 131, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 95, "name": "joinPush", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 127, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 94, "name": "joinedOnce", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 126, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 102, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 98, "name": "presence", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 130, "character": 2 } ], "type": { "type": "reference", "id": 1, "name": "default", "dereferenced": { "id": 1, "name": "RealtimePresence", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 36, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 84, "character": 2 } ], "signatures": [ { "id": 37, "name": "new RealtimePresence", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Presence." }, "parameters": [ { "id": 38, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The RealtimeChannel" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": "[Circular ~.children.5.children.32.signatures.0.parameters.0.type.dereferenced]" } }, { "id": 39, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" }, "type": { "type": "reference", "qualifiedName": "PresenceOpts", "package": "@types/phoenix", "name": "PresenceOpts" } } ], "type": { "type": "reference", "id": 1, "name": "default" } } ] }, { "id": 44, "name": "caller", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 67, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 45, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 46, "name": "onJoin", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 68, "character": 4 } ], "type": { "type": "reference", "qualifiedName": "PresenceOnJoinCallback", "package": "@types/phoenix", "name": "PresenceOnJoinCallback" } }, { "id": 47, "name": "onLeave", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 69, "character": 4 } ], "type": { "type": "reference", "qualifiedName": "PresenceOnLeaveCallback", "package": "@types/phoenix", "name": "PresenceOnLeaveCallback" } }, { "id": 48, "name": "onSync", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 70, "character": 4 } ], "signatures": [ { "id": 49, "name": "onSync", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [46, 47] }, { "title": "Methods", "kind": 2048, "children": [48] } ] } }, "defaultValue": "..." }, { "id": 50, "name": "channel", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": "[Circular ~.children.5.children.32.signatures.0.parameters.0.type.dereferenced]" } }, { "id": 43, "name": "joinRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 42, "name": "pendingDiffs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 65, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "RawPresenceDiff" } }, "defaultValue": "[]" }, { "id": 40, "name": "state", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 64, "character": 2 } ], "type": { "type": "reference", "id": 578, "typeArguments": [ { "type": "reflection", "declaration": { "id": 41, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } ], "name": "RealtimePresenceState", "dereferenced": { "id": 578, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 12 } ], "typeParameter": [ { "id": 586, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 582, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 44 } ], "indexSignature": { "id": 583, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 584, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 69 } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 579, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 75 } ], "indexSignature": { "id": 580, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 581, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 586, "name": "T" } ], "name": "Presence" } } } } } } }, "defaultValue": "{}" } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [36] }, { "title": "Properties", "kind": 1024, "children": [44, 50, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, "character": 21 } ] } } }, { "id": 97, "name": "pushBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 129, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "default" } }, "defaultValue": "[]" }, { "id": 96, "name": "rejoinTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 128, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 103, "name": "socket", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": "[Circular ~.children.5.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [ 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } }, { "id": 93, "name": "state", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 125, "character": 2 } ], "type": { "type": "reference", "name": "CHANNEL_STATES" }, "defaultValue": "CHANNEL_STATES.closed" }, { "id": 100, "name": "subTopic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 132, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 92, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 124, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 101, "name": "topic", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 269, "name": "_fetchWithTimeout", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 538, "character": 8 } ], "signatures": [ { "id": 270, "name": "_fetchWithTimeout", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 271, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 272, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 274, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 275, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 276, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 135, "name": "on", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 350, "character": 2 } ], "signatures": [ { "id": 136, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates an event handler that listens to changes." }, "parameters": [ { "id": 137, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 138, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 139, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 140, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 352, "character": 14 } ], "type": { "type": "literal", "value": "sync" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [140] } ] } } }, { "id": 141, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 143, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 144, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 148, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 145, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 146, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 147, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 149, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 150, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 152, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 357, "character": 14 } ], "type": { "type": "literal", "value": "join" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [152] } ] } } }, { "id": 153, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 154, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 155, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 156, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 558, "typeArguments": [ { "type": "reference", "id": 148, "name": "T" } ], "name": "RealtimePresenceJoinPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 157, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 161, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 159, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 160, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 162, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 163, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 165, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 362, "character": 14 } ], "type": { "type": "literal", "value": "leave" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [165] } ] } } }, { "id": 166, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 167, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 168, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 169, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 568, "typeArguments": [ { "type": "reference", "id": 161, "name": "T" } ], "name": "RealtimePresenceLeavePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 170, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 174, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 172, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 173, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 175, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 176, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "*" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 177, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 179, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 180, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 524, "typeArguments": [ { "type": "reference", "id": 174, "name": "T" } ], "name": "RealtimePostgresChangesPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 181, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 185, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 183, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 184, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 186, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 187, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "INSERT" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 188, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 190, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 191, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 529, "typeArguments": [ { "type": "reference", "id": 185, "name": "T" } ], "name": "RealtimePostgresInsertPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 192, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 196, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 193, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 194, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 195, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 197, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 198, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "UPDATE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 199, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 200, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 201, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 202, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 539, "typeArguments": [ { "type": "reference", "id": 196, "name": "T" } ], "name": "RealtimePostgresUpdatePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 203, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 207, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 205, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 206, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 208, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 209, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "DELETE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 210, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 212, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 213, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 548, "typeArguments": [ { "type": "reference", "id": 207, "name": "T" } ], "name": "RealtimePostgresDeletePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 214, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." }, "parameters": [ { "id": 215, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." }, "type": { "type": "literal", "value": "broadcast" } }, { "id": 216, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." }, "type": { "type": "reflection", "declaration": { "id": 217, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 218, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 393, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [218] } ] } } }, { "id": 219, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Function to be invoked when event handler is triggered.\n" }, "type": { "type": "reflection", "declaration": { "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 221, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 222, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 223, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 225, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 396, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 395, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [225, 224] } ], "indexSignature": { "id": 226, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 227, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 228, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 232, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 230, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 231, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 233, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "broadcast" } }, { "id": 234, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 236, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 402, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [236] } ] } } }, { "id": 237, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 238, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 239, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 240, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 241, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 243, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 405, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 244, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 406, "character": 6 } ], "type": { "type": "reference", "id": 232, "name": "T" } }, { "id": 242, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 404, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [243, 244, 242] } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 112, "name": "presenceState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 315, "character": 2 } ], "signatures": [ { "id": 113, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 118, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 114, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 115, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 116, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 117, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } } ], "type": { "type": "reference", "id": 578, "typeArguments": [ { "type": "reference", "id": 118, "name": "T" } ], "name": "RealtimePresenceState" } } ] }, { "id": 245, "name": "send", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 425, "character": 8 } ], "signatures": [ { "id": 246, "name": "send", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a message into the channel." }, "parameters": [ { "id": 247, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Arguments to send to channel" }, "type": { "type": "reflection", "declaration": { "id": 248, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 250, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The name of the event being sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 428, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 251, "name": "payload", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Payload to be sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 429, "character": 6 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 249, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of event to send" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 427, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "presence" }, { "type": "literal", "value": "broadcast" }, { "type": "literal", "value": "postgres_changes" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [250, 251, 249] } ], "indexSignature": { "id": 252, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 253, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 254, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Options to be used during the send process\n" }, "type": { "type": "reflection", "declaration": { "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 256, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 257, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 104, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 198, "character": 2 } ], "signatures": [ { "id": 105, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Subscribe registers your client with the server" }, "parameters": [ { "id": 106, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 107, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 108, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 109, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "SUBSCRIBED" }, { "type": "literal", "value": "TIMED_OUT" }, { "type": "literal", "value": "CLOSED" }, { "type": "literal", "value": "CHANNEL_ERROR" } ] } }, { "id": 110, "name": "err", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } }, { "id": 111, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 119, "name": "track", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 321, "character": 8 } ], "signatures": [ { "id": 120, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 121, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 122, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 123, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 124, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 125, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 126, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 127, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 128, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 264, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 495, "character": 2 } ], "signatures": [ { "id": 265, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Leaves the channel.", "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" }, "parameters": [ { "id": 266, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "error" }, { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 129, "name": "untrack", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 335, "character": 8 } ], "signatures": [ { "id": 130, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 131, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 132, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 133, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 134, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 258, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 482, "character": 2 } ], "signatures": [ { "id": 259, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 260, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 262, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 263, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] }, { "title": "Methods", "kind": 2048, "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 433, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 308, "character": 2 } ], "signatures": [ { "id": 434, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 435, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] }, { "id": 1, "name": "RealtimePresence", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 36, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 84, "character": 2 } ], "signatures": [ { "id": 37, "name": "new RealtimePresence", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Presence." }, "parameters": [ { "id": 38, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The RealtimeChannel" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": [ { "id": 75, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 134, "character": 2 } ], "signatures": [ { "id": 76, "name": "new RealtimeChannel", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 77, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 78, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 79, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 360, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 112, "character": 2 } ], "signatures": [ { "id": 361, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 362, "name": "endPoint", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 491, "name": "RealtimeClientOptions", "dereferenced": { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 359, "name": "default" } } ] }, { "id": 364, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 365, "name": "apiKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 366, "name": "channels", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 67, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } }, "defaultValue": "[]" }, { "id": 387, "name": "conn", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 82, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLike" } ] }, "defaultValue": "null" }, { "id": 385, "name": "decode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 384, "name": "encode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 79, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 367, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" }, { "id": 396, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 96, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 398, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 399, "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": 400, "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": 401, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 402, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "Request", "package": "typescript", "name": "Request" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 403, "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": 368, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 69, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 370, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 371, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 378, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 379, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 74, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "qualifiedName": "global.NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } ] }, "defaultValue": "undefined" }, { "id": 383, "name": "logger", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 78, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "noop" }, { "id": 372, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 70, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 374, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 375, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 380, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 75, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 386, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 81, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 382, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 77, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 381, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 388, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 83, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, "defaultValue": "[]" }, { "id": 389, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 84, "character": 2 } ], "type": { "type": "reference", "name": "default" }, "defaultValue": "..." }, { "id": 390, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 85, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 393, "name": "close", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 87, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 394, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 88, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 395, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 89, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 392, "name": "open", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 86, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [393, 394, 395, 392] } ] } }, "defaultValue": "..." }, { "id": 376, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 377, "name": "transport", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLikeConstructor" } ] } }, { "id": 426, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 274, "character": 2 } ], "signatures": [ { "id": 427, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 354, 353 ] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 404, "name": "connect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 405, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 422, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 423, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "name": "CONNECTION_STATE" } } ] }, { "id": 406, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 195, "character": 2 } ], "signatures": [ { "id": 407, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 408, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A numeric status code to send on disconnect." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 409, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A custom reason for the disconnect.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 410, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 213, "character": 2 } ], "signatures": [ { "id": 411, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all created channels" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } } } ] }, { "id": 424, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 270, "character": 2 } ], "signatures": [ { "id": 425, "name": "isConnected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns `true` is the connection is open." }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 417, "name": "log", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 247, "character": 2 } ], "signatures": [ { "id": 418, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overridden.\n" }, "parameters": [ { "id": 419, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 430, "name": "push", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 288, "character": 2 } ], "signatures": [ { "id": 431, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 432, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 510, "name": "RealtimeMessage", "dereferenced": { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 513, 516, 514, 515, 512 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 415, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 234, "character": 8 } ], "signatures": [ { "id": 416, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all channels" }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 412, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 413, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes a single channel" }, "parameters": [ { "id": 414, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A RealtimeChannel instance\n" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": "[Circular ~.children.6.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 433, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 308, "character": 2 } ], "signatures": [ { "id": 434, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 435, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [ 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 80, "name": "bindings", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 116, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 82, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 83, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 90, "name": "callback", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 120, "character": 6 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 86, "name": "filter", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 14 } ], "indexSignature": { "id": 88, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 89, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 91, "name": "id", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 121, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 85, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 118, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [90, 86, 91, 85] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 117, "character": 19 } ] } } } } } }, "defaultValue": "{}" }, { "id": 99, "name": "broadcastEndpointURL", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 131, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 95, "name": "joinPush", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 127, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 94, "name": "joinedOnce", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 126, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 102, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 98, "name": "presence", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 130, "character": 2 } ], "type": { "type": "reference", "id": 1, "name": "default", "dereferenced": { "id": 1, "name": "RealtimePresence", "kind": 128, "kindString": "Class", "flags": {}, "children": "[Circular ~.children.6.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [36] }, { "title": "Properties", "kind": 1024, "children": [44, 50, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, "character": 21 } ] } } }, { "id": 97, "name": "pushBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 129, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "default" } }, "defaultValue": "[]" }, { "id": 96, "name": "rejoinTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 128, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 103, "name": "socket", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 360, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 112, "character": 2 } ], "signatures": [ { "id": 361, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 362, "name": "endPoint", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 491, "name": "RealtimeClientOptions", "dereferenced": { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 359, "name": "default" } } ] }, { "id": 364, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 365, "name": "apiKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 366, "name": "channels", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 67, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } }, "defaultValue": "[]" }, { "id": 387, "name": "conn", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 82, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLike" } ] }, "defaultValue": "null" }, { "id": 385, "name": "decode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 384, "name": "encode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 79, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 367, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" }, { "id": 396, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 96, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 398, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 399, "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": 400, "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": 401, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 402, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "Request", "package": "typescript", "name": "Request" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 403, "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": 368, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 69, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 370, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 371, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 378, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 379, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 74, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "qualifiedName": "global.NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } ] }, "defaultValue": "undefined" }, { "id": 383, "name": "logger", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 78, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "noop" }, { "id": 372, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 70, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 374, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 375, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 380, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 75, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 386, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 81, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 382, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 77, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 381, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 388, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 83, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, "defaultValue": "[]" }, { "id": 389, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 84, "character": 2 } ], "type": { "type": "reference", "name": "default" }, "defaultValue": "..." }, { "id": 390, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 85, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 393, "name": "close", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 87, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 394, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 88, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 395, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 89, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 392, "name": "open", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 86, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [393, 394, 395, 392] } ] } }, "defaultValue": "..." }, { "id": 376, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 377, "name": "transport", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLikeConstructor" } ] } }, { "id": 426, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 274, "character": 2 } ], "signatures": [ { "id": 427, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 404, "name": "connect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 405, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 422, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 423, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "name": "CONNECTION_STATE" } } ] }, { "id": 406, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 195, "character": 2 } ], "signatures": [ { "id": 407, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 408, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A numeric status code to send on disconnect." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 409, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A custom reason for the disconnect.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 410, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 213, "character": 2 } ], "signatures": [ { "id": 411, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all created channels" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } } } ] }, { "id": 424, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 270, "character": 2 } ], "signatures": [ { "id": 425, "name": "isConnected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns `true` is the connection is open." }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 417, "name": "log", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 247, "character": 2 } ], "signatures": [ { "id": 418, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overridden.\n" }, "parameters": [ { "id": 419, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 430, "name": "push", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 288, "character": 2 } ], "signatures": [ { "id": 431, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 432, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 510, "name": "RealtimeMessage", "dereferenced": { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 516, 514, 515, 512] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 415, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 234, "character": 8 } ], "signatures": [ { "id": 416, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all channels" }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 412, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 413, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes a single channel" }, "parameters": [ { "id": 414, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A RealtimeChannel instance\n" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": "[Circular ~.children.6.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 433, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 308, "character": 2 } ], "signatures": [ { "id": 434, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 435, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [ 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } }, { "id": 93, "name": "state", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 125, "character": 2 } ], "type": { "type": "reference", "name": "CHANNEL_STATES" }, "defaultValue": "CHANNEL_STATES.closed" }, { "id": 100, "name": "subTopic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 132, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 92, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 124, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 101, "name": "topic", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 269, "name": "_fetchWithTimeout", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 538, "character": 8 } ], "signatures": [ { "id": 270, "name": "_fetchWithTimeout", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 271, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 272, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 274, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 275, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 276, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 135, "name": "on", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 350, "character": 2 } ], "signatures": [ { "id": 136, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates an event handler that listens to changes." }, "parameters": [ { "id": 137, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 138, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 139, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 140, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 352, "character": 14 } ], "type": { "type": "literal", "value": "sync" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [140] } ] } } }, { "id": 141, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 143, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 144, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 148, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 145, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 146, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 147, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 149, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 150, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 152, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 357, "character": 14 } ], "type": { "type": "literal", "value": "join" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [152] } ] } } }, { "id": 153, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 154, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 155, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 156, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 558, "typeArguments": [ { "type": "reference", "id": 148, "name": "T" } ], "name": "RealtimePresenceJoinPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 157, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 161, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 159, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 160, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 162, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 163, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 165, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 362, "character": 14 } ], "type": { "type": "literal", "value": "leave" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [165] } ] } } }, { "id": 166, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 167, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 168, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 169, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 568, "typeArguments": [ { "type": "reference", "id": 161, "name": "T" } ], "name": "RealtimePresenceLeavePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 170, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 174, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 172, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 173, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 175, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 176, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "*" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 177, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 179, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 180, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 524, "typeArguments": [ { "type": "reference", "id": 174, "name": "T" } ], "name": "RealtimePostgresChangesPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 181, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 185, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 183, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 184, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 186, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 187, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "INSERT" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 188, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 190, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 191, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 529, "typeArguments": [ { "type": "reference", "id": 185, "name": "T" } ], "name": "RealtimePostgresInsertPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 192, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 196, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 193, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 194, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 195, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 197, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 198, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "UPDATE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 199, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 200, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 201, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 202, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 539, "typeArguments": [ { "type": "reference", "id": 196, "name": "T" } ], "name": "RealtimePostgresUpdatePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 203, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 207, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 205, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 206, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 208, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 209, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "DELETE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 210, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 212, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 213, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 548, "typeArguments": [ { "type": "reference", "id": 207, "name": "T" } ], "name": "RealtimePostgresDeletePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 214, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." }, "parameters": [ { "id": 215, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." }, "type": { "type": "literal", "value": "broadcast" } }, { "id": 216, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." }, "type": { "type": "reflection", "declaration": { "id": 217, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 218, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 393, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [218] } ] } } }, { "id": 219, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Function to be invoked when event handler is triggered.\n" }, "type": { "type": "reflection", "declaration": { "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 221, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 222, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 223, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 225, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 396, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 395, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [225, 224] } ], "indexSignature": { "id": 226, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 227, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 228, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 232, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 230, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 231, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 233, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "broadcast" } }, { "id": 234, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 236, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 402, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [236] } ] } } }, { "id": 237, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 238, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 239, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 240, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 241, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 243, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 405, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 244, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 406, "character": 6 } ], "type": { "type": "reference", "id": 232, "name": "T" } }, { "id": 242, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 404, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [243, 244, 242] } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 112, "name": "presenceState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 315, "character": 2 } ], "signatures": [ { "id": 113, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 118, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 114, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 115, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 116, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 117, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } } ], "type": { "type": "reference", "id": 578, "typeArguments": [ { "type": "reference", "id": 118, "name": "T" } ], "name": "RealtimePresenceState" } } ] }, { "id": 245, "name": "send", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 425, "character": 8 } ], "signatures": [ { "id": 246, "name": "send", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a message into the channel." }, "parameters": [ { "id": 247, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Arguments to send to channel" }, "type": { "type": "reflection", "declaration": { "id": 248, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 250, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The name of the event being sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 428, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 251, "name": "payload", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Payload to be sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 429, "character": 6 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 249, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of event to send" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 427, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "presence" }, { "type": "literal", "value": "broadcast" }, { "type": "literal", "value": "postgres_changes" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [250, 251, 249] } ], "indexSignature": { "id": 252, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 253, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 254, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Options to be used during the send process\n" }, "type": { "type": "reflection", "declaration": { "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 256, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 257, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 104, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 198, "character": 2 } ], "signatures": [ { "id": 105, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Subscribe registers your client with the server" }, "parameters": [ { "id": 106, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 107, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 108, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 109, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "SUBSCRIBED" }, { "type": "literal", "value": "TIMED_OUT" }, { "type": "literal", "value": "CLOSED" }, { "type": "literal", "value": "CHANNEL_ERROR" } ] } }, { "id": 110, "name": "err", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } }, { "id": 111, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 119, "name": "track", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 321, "character": 8 } ], "signatures": [ { "id": 120, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 121, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 122, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 123, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 124, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 125, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 126, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 127, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 128, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 264, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 495, "character": 2 } ], "signatures": [ { "id": 265, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Leaves the channel.", "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" }, "parameters": [ { "id": 266, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "error" }, { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 129, "name": "untrack", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 335, "character": 8 } ], "signatures": [ { "id": 130, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 131, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 132, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 133, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 134, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 258, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 482, "character": 2 } ], "signatures": [ { "id": 259, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 260, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 262, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 263, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] }, { "title": "Methods", "kind": 2048, "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] } } }, { "id": 39, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" }, "type": { "type": "reference", "qualifiedName": "PresenceOpts", "package": "@types/phoenix", "name": "PresenceOpts" } } ], "type": { "type": "reference", "id": 1, "name": "default" } } ] }, { "id": 44, "name": "caller", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 67, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 45, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 46, "name": "onJoin", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 68, "character": 4 } ], "type": { "type": "reference", "qualifiedName": "PresenceOnJoinCallback", "package": "@types/phoenix", "name": "PresenceOnJoinCallback" } }, { "id": 47, "name": "onLeave", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 69, "character": 4 } ], "type": { "type": "reference", "qualifiedName": "PresenceOnLeaveCallback", "package": "@types/phoenix", "name": "PresenceOnLeaveCallback" } }, { "id": 48, "name": "onSync", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 70, "character": 4 } ], "signatures": [ { "id": 49, "name": "onSync", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [46, 47] }, { "title": "Methods", "kind": 2048, "children": [48] } ] } }, "defaultValue": "..." }, { "id": 50, "name": "channel", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": { "id": 64, "name": "RealtimeChannel", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." }, "children": [ { "id": 75, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 134, "character": 2 } ], "signatures": [ { "id": 76, "name": "new RealtimeChannel", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 77, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 78, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 79, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 360, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 112, "character": 2 } ], "signatures": [ { "id": 361, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 362, "name": "endPoint", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 491, "name": "RealtimeClientOptions", "dereferenced": { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 359, "name": "default" } } ] }, { "id": 364, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 365, "name": "apiKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 366, "name": "channels", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 67, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } }, "defaultValue": "[]" }, { "id": 387, "name": "conn", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 82, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLike" } ] }, "defaultValue": "null" }, { "id": 385, "name": "decode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 384, "name": "encode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 79, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 367, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" }, { "id": 396, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 96, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 398, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 399, "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": 400, "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": 401, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 402, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "Request", "package": "typescript", "name": "Request" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 403, "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": 368, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 69, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 370, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 371, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 378, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 379, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 74, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "qualifiedName": "global.NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } ] }, "defaultValue": "undefined" }, { "id": 383, "name": "logger", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 78, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "noop" }, { "id": 372, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 70, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 374, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 375, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 380, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 75, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 386, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 81, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 382, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 77, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 381, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 388, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 83, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, "defaultValue": "[]" }, { "id": 389, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 84, "character": 2 } ], "type": { "type": "reference", "name": "default" }, "defaultValue": "..." }, { "id": 390, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 85, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 393, "name": "close", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 87, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 394, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 88, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 395, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 89, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 392, "name": "open", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 86, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [393, 394, 395, 392] } ] } }, "defaultValue": "..." }, { "id": 376, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 377, "name": "transport", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLikeConstructor" } ] } }, { "id": 426, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 274, "character": 2 } ], "signatures": [ { "id": 427, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 404, "name": "connect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 405, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 422, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 423, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "name": "CONNECTION_STATE" } } ] }, { "id": 406, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 195, "character": 2 } ], "signatures": [ { "id": 407, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 408, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A numeric status code to send on disconnect." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 409, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A custom reason for the disconnect.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 410, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 213, "character": 2 } ], "signatures": [ { "id": 411, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all created channels" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } } } ] }, { "id": 424, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 270, "character": 2 } ], "signatures": [ { "id": 425, "name": "isConnected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns `true` is the connection is open." }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 417, "name": "log", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 247, "character": 2 } ], "signatures": [ { "id": 418, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overridden.\n" }, "parameters": [ { "id": 419, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 430, "name": "push", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 288, "character": 2 } ], "signatures": [ { "id": 431, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 432, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 510, "name": "RealtimeMessage", "dereferenced": { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 516, 514, 515, 512] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 415, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 234, "character": 8 } ], "signatures": [ { "id": 416, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all channels" }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 412, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 413, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes a single channel" }, "parameters": [ { "id": 414, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A RealtimeChannel instance\n" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": "[Circular ~.children.6.children.2.type.dereferenced]" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 433, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 308, "character": 2 } ], "signatures": [ { "id": 434, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 435, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [ 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 80, "name": "bindings", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 116, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 82, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 83, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 90, "name": "callback", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 120, "character": 6 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 86, "name": "filter", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 119, "character": 14 } ], "indexSignature": { "id": 88, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 89, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 91, "name": "id", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 121, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 85, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 118, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [90, 86, 91, 85] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 117, "character": 19 } ] } } } } } }, "defaultValue": "{}" }, { "id": 99, "name": "broadcastEndpointURL", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 131, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 95, "name": "joinPush", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 127, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 94, "name": "joinedOnce", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 126, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 102, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." }, { "id": 98, "name": "presence", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 130, "character": 2 } ], "type": { "type": "reference", "id": 1, "name": "default", "dereferenced": { "id": 1, "name": "RealtimePresence", "kind": 128, "kindString": "Class", "flags": {}, "children": "[Circular ~.children.6.children]", "groups": [ { "title": "Constructors", "kind": 512, "children": [36] }, { "title": "Properties", "kind": 1024, "children": [44, 50, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, "character": 21 } ] } } }, { "id": 97, "name": "pushBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 129, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "default" } }, "defaultValue": "[]" }, { "id": 96, "name": "rejoinTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 128, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 103, "name": "socket", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "reference", "id": 359, "name": "default", "dereferenced": { "id": 359, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 360, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 112, "character": 2 } ], "signatures": [ { "id": 361, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Initializes the Socket." }, "parameters": [ { "id": 362, "name": "endPoint", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 363, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 491, "name": "RealtimeClientOptions", "dereferenced": { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } } } } ], "type": { "type": "reference", "id": 359, "name": "default" } } ] }, { "id": 364, "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 65, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 365, "name": "apiKey", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 366, "name": "channels", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 67, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } }, "defaultValue": "[]" }, { "id": 387, "name": "conn", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 82, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLike" } ] }, "defaultValue": "null" }, { "id": 385, "name": "decode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 80, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 384, "name": "encode", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 79, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 367, "name": "endPoint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 68, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" }, { "id": 396, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 96, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 398, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 399, "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": 400, "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": 401, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 402, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "Request", "package": "typescript", "name": "Request" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 403, "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": 368, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 69, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 370, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 371, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 378, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 73, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "30000" }, { "id": 379, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 74, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "qualifiedName": "global.NodeJS.Timeout", "package": "@types/node", "name": "Timeout" } ] }, "defaultValue": "undefined" }, { "id": 383, "name": "logger", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 78, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" }, "defaultValue": "noop" }, { "id": 372, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 70, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 374, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 375, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 380, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 75, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 386, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 81, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 382, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 77, "character": 2 } ], "type": { "type": "reference", "name": "default" } }, { "id": 381, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 388, "name": "sendBuffer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 83, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, "defaultValue": "[]" }, { "id": 389, "name": "serializer", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 84, "character": 2 } ], "type": { "type": "reference", "name": "default" }, "defaultValue": "..." }, { "id": 390, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 85, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 393, "name": "close", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 87, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 394, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 88, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 395, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 89, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } }, { "id": 392, "name": "open", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 86, "character": 4 } ], "type": { "type": "array", "elementType": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [393, 394, 395, 392] } ] } }, "defaultValue": "..." }, { "id": 376, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 71, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "DEFAULT_TIMEOUT" }, { "id": 377, "name": "transport", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 72, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "name": "WebSocketLikeConstructor" } ] } }, { "id": 426, "name": "channel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 274, "character": 2 } ], "signatures": [ { "id": 427, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 428, "name": "topic", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 347, "name": "RealtimeChannelOptions", "dereferenced": { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } } }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 404, "name": "connect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 157, "character": 2 } ], "signatures": [ { "id": 405, "name": "connect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Connects the socket, unless already connected." }, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 422, "name": "connectionState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 423, "name": "connectionState", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns the current state of the socket." }, "type": { "type": "reference", "name": "CONNECTION_STATE" } } ] }, { "id": 406, "name": "disconnect", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 195, "character": 2 } ], "signatures": [ { "id": 407, "name": "disconnect", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Disconnects the socket." }, "parameters": [ { "id": 408, "name": "code", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A numeric status code to send on disconnect." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 409, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "A custom reason for the disconnect.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 410, "name": "getChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 213, "character": 2 } ], "signatures": [ { "id": 411, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns all created channels" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 64, "name": "default" } } } ] }, { "id": 424, "name": "isConnected", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 270, "character": 2 } ], "signatures": [ { "id": 425, "name": "isConnected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Returns `true` is the connection is open." }, "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 417, "name": "log", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 247, "character": 2 } ], "signatures": [ { "id": 418, "name": "log", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Logs the message.", "text": "For customized logging, `this.logger` can be overridden.\n" }, "parameters": [ { "id": 419, "name": "kind", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 430, "name": "push", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 288, "character": 2 } ], "signatures": [ { "id": 431, "name": "push", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Push out a message if the socket is connected.", "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" }, "parameters": [ { "id": 432, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 510, "name": "RealtimeMessage", "dereferenced": { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 516, 514, 515, 512] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 415, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 234, "character": 8 } ], "signatures": [ { "id": 416, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes all channels" }, "type": { "type": "reference", "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 412, "name": "removeChannel", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 221, "character": 8 } ], "signatures": [ { "id": 413, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Unsubscribes and removes a single channel" }, "parameters": [ { "id": 414, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A RealtimeChannel instance\n" }, "type": { "type": "reference", "id": 64, "name": "default", "dereferenced": "[Circular ~.children.6.children.2.type.dereferenced]" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 587, "name": "RealtimeRemoveChannelResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 433, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 308, "character": 2 } ], "signatures": [ { "id": 434, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." }, "parameters": [ { "id": 435, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A JWT string.\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [360] }, { "title": "Properties", "kind": 1024, "children": [ 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 ] }, { "title": "Methods", "kind": 2048, "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 64, "character": 21 } ] } } }, { "id": 93, "name": "state", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 125, "character": 2 } ], "type": { "type": "reference", "name": "CHANNEL_STATES" }, "defaultValue": "CHANNEL_STATES.closed" }, { "id": 100, "name": "subTopic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 132, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 92, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 124, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 101, "name": "topic", "kind": 1024, "kindString": "Property", "flags": { "isPublic": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 269, "name": "_fetchWithTimeout", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 538, "character": 8 } ], "signatures": [ { "id": 270, "name": "_fetchWithTimeout", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 271, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 272, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 274, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 275, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 276, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 135, "name": "on", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 350, "character": 2 } ], "signatures": [ { "id": 136, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates an event handler that listens to changes." }, "parameters": [ { "id": 137, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 138, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 139, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 140, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 352, "character": 14 } ], "type": { "type": "literal", "value": "sync" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [140] } ] } } }, { "id": 141, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 143, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 144, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 148, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 145, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 146, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 147, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 149, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 150, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 152, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 357, "character": 14 } ], "type": { "type": "literal", "value": "join" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [152] } ] } } }, { "id": 153, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 154, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 155, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 156, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 558, "typeArguments": [ { "type": "reference", "id": 148, "name": "T" } ], "name": "RealtimePresenceJoinPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 157, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 161, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 159, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 160, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 162, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "presence" } }, { "id": 163, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 165, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 362, "character": 14 } ], "type": { "type": "literal", "value": "leave" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [165] } ] } } }, { "id": 166, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 167, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 168, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 169, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 568, "typeArguments": [ { "type": "reference", "id": 161, "name": "T" } ], "name": "RealtimePresenceLeavePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 170, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 174, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 172, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 173, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 175, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 176, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "*" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 177, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 179, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 180, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 524, "typeArguments": [ { "type": "reference", "id": 174, "name": "T" } ], "name": "RealtimePostgresChangesPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 181, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 185, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 183, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 184, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 186, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 187, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "INSERT" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 188, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 190, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 191, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 529, "typeArguments": [ { "type": "reference", "id": 185, "name": "T" } ], "name": "RealtimePostgresInsertPayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 192, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 196, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 193, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 194, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 195, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 197, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 198, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "UPDATE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 199, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 200, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 201, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 202, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 539, "typeArguments": [ { "type": "reference", "id": 196, "name": "T" } ], "name": "RealtimePostgresUpdatePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 203, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 207, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 205, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 206, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 208, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "postgres_changes" } }, { "id": 209, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 517, "typeArguments": [ { "type": "literal", "value": "DELETE" } ], "name": "RealtimePostgresChangesFilter", "dereferenced": { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } } } }, { "id": 210, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 212, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 213, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 548, "typeArguments": [ { "type": "reference", "id": 207, "name": "T" } ], "name": "RealtimePostgresDeletePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 214, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." }, "parameters": [ { "id": 215, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." }, "type": { "type": "literal", "value": "broadcast" } }, { "id": 216, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." }, "type": { "type": "reflection", "declaration": { "id": 217, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 218, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 393, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [218] } ] } } }, { "id": 219, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Function to be invoked when event handler is triggered.\n" }, "type": { "type": "reflection", "declaration": { "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 221, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 222, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 223, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 225, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 396, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 395, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [225, 224] } ], "indexSignature": { "id": 226, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 227, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } }, { "id": 228, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 232, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 230, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 231, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "parameters": [ { "id": 233, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "literal", "value": "broadcast" } }, { "id": 234, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 236, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 402, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [236] } ] } } }, { "id": 237, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 238, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 239, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 240, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 241, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 243, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 405, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 244, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 406, "character": 6 } ], "type": { "type": "reference", "id": 232, "name": "T" } }, { "id": 242, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 404, "character": 6 } ], "type": { "type": "literal", "value": "broadcast" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [243, 244, 242] } ] } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 112, "name": "presenceState", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 315, "character": 2 } ], "signatures": [ { "id": 113, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 118, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 114, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 115, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 116, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 117, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } } ], "type": { "type": "reference", "id": 578, "typeArguments": [ { "type": "reference", "id": 118, "name": "T" } ], "name": "RealtimePresenceState" } } ] }, { "id": 245, "name": "send", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 425, "character": 8 } ], "signatures": [ { "id": 246, "name": "send", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Sends a message into the channel." }, "parameters": [ { "id": 247, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Arguments to send to channel" }, "type": { "type": "reflection", "declaration": { "id": 248, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 250, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The name of the event being sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 428, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 251, "name": "payload", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Payload to be sent" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 429, "character": 6 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 249, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of event to send" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 427, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "presence" }, { "type": "literal", "value": "broadcast" }, { "type": "literal", "value": "postgres_changes" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [250, 251, 249] } ], "indexSignature": { "id": 252, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 253, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 254, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Options to be used during the send process\n" }, "type": { "type": "reflection", "declaration": { "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 256, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 257, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 104, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 198, "character": 2 } ], "signatures": [ { "id": 105, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Subscribe registers your client with the server" }, "parameters": [ { "id": 106, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 107, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 108, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 109, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": "SUBSCRIBED" }, { "type": "literal", "value": "TIMED_OUT" }, { "type": "literal", "value": "CLOSED" }, { "type": "literal", "value": "CHANNEL_ERROR" } ] } }, { "id": 110, "name": "err", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } }, { "id": 111, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "id": 64, "name": "default" } } ] }, { "id": 119, "name": "track", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 321, "character": 8 } ], "signatures": [ { "id": 120, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 121, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 122, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 123, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 124, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 125, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 126, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 127, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 128, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 264, "name": "unsubscribe", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 495, "character": 2 } ], "signatures": [ { "id": 265, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Leaves the channel.", "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" }, "parameters": [ { "id": 266, "name": "timeout", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "error" }, { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 129, "name": "untrack", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 335, "character": 8 } ], "signatures": [ { "id": 130, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 131, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 132, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 133, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 134, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 358, "name": "RealtimeChannelSendResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 258, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 482, "character": 2 } ], "signatures": [ { "id": 259, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 260, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 262, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 263, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [75] }, { "title": "Properties", "kind": 1024, "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] }, { "title": "Methods", "kind": 2048, "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 115, "character": 21 } ] } } }, { "id": 43, "name": "joinRef", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 66, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] }, "defaultValue": "null" }, { "id": 42, "name": "pendingDiffs", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 65, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "name": "RawPresenceDiff" } }, "defaultValue": "[]" }, { "id": 40, "name": "state", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 64, "character": 2 } ], "type": { "type": "reference", "id": 578, "typeArguments": [ { "type": "reflection", "declaration": { "id": 41, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } } ], "name": "RealtimePresenceState", "dereferenced": { "id": 578, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 12 } ], "typeParameter": [ { "id": 586, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 582, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 44 } ], "indexSignature": { "id": 583, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 584, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 69 } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 579, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 75 } ], "indexSignature": { "id": 580, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 581, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 586, "name": "T" } ], "name": "Presence" } } } } } } }, "defaultValue": "{}" } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [36] }, { "title": "Properties", "kind": 1024, "children": [44, 50, 43, 42, 40] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 63, "character": 21 } ] }, { "id": 347, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 349, "name": "config", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 350, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 351, "name": "broadcast", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "ack", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 34 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 353, "name": "self", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 21, "character": 16 } ] } } }, { "id": 355, "name": "presence", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "key option is used to track presence payload across clients" }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 357, "name": "key", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 17 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [357] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 25, "character": 15 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [351, 355] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 16, "character": 10 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [349] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 15, "character": 37 } ] } } }, { "id": 358, "name": "RealtimeChannelSendResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 83, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" }, { "type": "literal", "value": "error" } ] } }, { "id": 491, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 498, "name": "decode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 497, "name": "encode", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 25, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 509, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 31, "character": 2 } ], "type": { "type": "reference", "name": "Fetch" } }, { "id": 500, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 501, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 28, "character": 12 } ], "indexSignature": { "id": 502, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 503, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 495, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 508, "name": "log_level", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 30, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "info" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "warn" }, { "type": "literal", "value": "error" } ] } }, { "id": 496, "name": "logger", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 24, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 504, "name": "params", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 505, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 29, "character": 11 } ], "indexSignature": { "id": 506, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 507, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } }, { "id": 499, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "Function", "package": "typescript", "name": "Function" } }, { "id": 494, "name": "timeout", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 493, "name": "transport", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "name": "WebSocketLikeConstructor" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 20, "character": 36 } ] } } }, { "id": 510, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 513, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 516, "name": "join_ref", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 39, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 514, "name": "payload", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 515, "name": "ref", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 38, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 512, "name": "topic", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [513, 516, 514, 515, 512] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 34, "character": 30 } ] } } }, { "id": 517, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 62, "character": 12 } ], "typeParameter": [ { "id": 523, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 592, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" ] ] } } ], "type": { "type": "reflection", "declaration": { "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 519, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The type of database change to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 68, "character": 2 } ], "type": { "type": "reference", "id": 523, "name": "T", "dereferenced": {} } }, { "id": 522, "name": "filter", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Receive database changes when filter is matched." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 80, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 520, "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The database schema to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 72, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 521, "name": "table", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The database table to listen to." }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 76, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [519, 522, 520, 521] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 64, "character": 4 } ] } } }, { "id": 524, "name": "RealtimePostgresChangesPayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 57, "character": 12 } ], "typeParameter": [ { "id": 528, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 525, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 57, "character": 53 } ], "indexSignature": { "id": 526, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 527, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "union", "types": [ { "id": 529, "name": "RealtimePostgresInsertPayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 36, "character": 12 } ], "typeParameter": [ { "id": 538, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 535, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 36, "character": 52 } ], "indexSignature": { "id": 536, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 537, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intersection", "types": [ { "type": "reference", "name": "RealtimePostgresChangesPayloadBase" }, { "type": "reflection", "declaration": { "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 531, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 38, "character": 4 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 594, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, "" ] ] } }, { "id": 532, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 39, "character": 4 } ], "type": { "type": "reference", "id": 538, "name": "T" } }, { "id": 533, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 40, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 534, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 40, "character": 9 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [531, 532, 533] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 37, "character": 39 } ] } } ] } }, { "id": 539, "name": "RealtimePostgresUpdatePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 43, "character": 12 } ], "typeParameter": [ { "id": 547, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 43, "character": 52 } ], "indexSignature": { "id": 545, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 546, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intersection", "types": [ { "type": "reference", "name": "RealtimePostgresChangesPayloadBase" }, { "type": "reflection", "declaration": { "id": 540, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 541, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, "character": 4 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 595, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, "" ] ] } }, { "id": 542, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 46, "character": 4 } ], "type": { "type": "reference", "id": 547, "name": "T" } }, { "id": 543, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 47, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 547, "name": "T" } ], "qualifiedName": "Partial", "package": "typescript", "name": "Partial" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [541, 542, 543] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 44, "character": 39 } ] } } ] } }, { "id": 548, "name": "RealtimePostgresDeletePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 50, "character": 12 } ], "typeParameter": [ { "id": 557, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 554, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 50, "character": 52 } ], "indexSignature": { "id": 555, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 556, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intersection", "types": [ { "type": "reference", "name": "RealtimePostgresChangesPayloadBase" }, { "type": "reflection", "declaration": { "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 550, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 52, "character": 4 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 596, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, "" ] ] } }, { "id": 551, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 53, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 552, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 53, "character": 9 } ] } } }, { "id": 553, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 54, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 557, "name": "T" } ], "qualifiedName": "Partial", "package": "typescript", "name": "Partial" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [550, 551, 553] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 51, "character": 39 } ] } } ] } } ] } }, { "id": 548, "name": "RealtimePostgresDeletePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 50, "character": 12 } ], "typeParameter": [ { "id": 557, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 554, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 50, "character": 52 } ], "indexSignature": { "id": 555, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 556, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intersection", "types": [ { "type": "reference", "name": "RealtimePostgresChangesPayloadBase" }, { "type": "reflection", "declaration": { "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 550, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 52, "character": 4 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 596, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, "" ] ] } }, { "id": 551, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 53, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 552, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 53, "character": 9 } ] } } }, { "id": 553, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 54, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 557, "name": "T" } ], "qualifiedName": "Partial", "package": "typescript", "name": "Partial" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [550, 551, 553] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 51, "character": 39 } ] } } ] } }, { "id": 529, "name": "RealtimePostgresInsertPayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 36, "character": 12 } ], "typeParameter": [ { "id": 538, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 535, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 36, "character": 52 } ], "indexSignature": { "id": 536, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 537, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intersection", "types": [ { "type": "reference", "name": "RealtimePostgresChangesPayloadBase" }, { "type": "reflection", "declaration": { "id": 530, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 531, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 38, "character": 4 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 594, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, "" ] ] } }, { "id": 532, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 39, "character": 4 } ], "type": { "type": "reference", "id": 538, "name": "T" } }, { "id": 533, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 40, "character": 4 } ], "type": { "type": "reflection", "declaration": { "id": 534, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 40, "character": 9 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [531, 532, 533] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 37, "character": 39 } ] } } ] } }, { "id": 539, "name": "RealtimePostgresUpdatePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 43, "character": 12 } ], "typeParameter": [ { "id": 547, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 43, "character": 52 } ], "indexSignature": { "id": 545, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 546, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "intersection", "types": [ { "type": "reference", "name": "RealtimePostgresChangesPayloadBase" }, { "type": "reflection", "declaration": { "id": 540, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 541, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 45, "character": 4 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 595, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, "" ] ] } }, { "id": 542, "name": "new", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 46, "character": 4 } ], "type": { "type": "reference", "id": 547, "name": "T" } }, { "id": 543, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 47, "character": 4 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 547, "name": "T" } ], "qualifiedName": "Partial", "package": "typescript", "name": "Partial" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [541, 542, 543] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 44, "character": 39 } ] } } ] } }, { "id": 558, "name": "RealtimePresenceJoinPayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, "character": 12 } ], "typeParameter": [ { "id": 567, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 564, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, "character": 50 } ], "indexSignature": { "id": 565, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 566, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "reflection", "declaration": { "id": 559, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 562, "name": "currentPresences", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 24, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 567, "name": "T" } ], "name": "Presence" } } }, { "id": 560, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 22, "character": 2 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 599, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" }, "" ] ] } }, { "id": 561, "name": "key", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 23, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 563, "name": "newPresences", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 25, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 567, "name": "T" } ], "name": "Presence" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [562, 560, 561, 563] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 21, "character": 76 } ] } } }, { "id": 568, "name": "RealtimePresenceLeavePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 28, "character": 12 } ], "typeParameter": [ { "id": 577, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 574, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 28, "character": 51 } ], "indexSignature": { "id": 575, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 576, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } } } ], "type": { "type": "reflection", "declaration": { "id": 569, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 572, "name": "currentPresences", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 31, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 577, "name": "T" } ], "name": "Presence" } } }, { "id": 570, "name": "event", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 29, "character": 2 } ], "type": { "type": "template-literal", "head": "", "tail": [ [ { "type": "reference", "id": 600, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" }, "" ] ] } }, { "id": 571, "name": "key", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 30, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 573, "name": "leftPresences", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 32, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 577, "name": "T" } ], "name": "Presence" } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [572, 570, 571, 573] } ], "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 28, "character": 77 } ] } } }, { "id": 578, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 12 } ], "typeParameter": [ { "id": 586, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 582, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 44 } ], "indexSignature": { "id": 583, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 584, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } } }, "default": { "type": "reflection", "declaration": { "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 69 } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 579, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/RealtimePresence.ts", "line": 17, "character": 75 } ], "indexSignature": { "id": 580, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 581, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 586, "name": "T" } ], "name": "Presence" } } } } } }, { "id": 587, "name": "RealtimeRemoveChannelResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", "line": 42, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "ok" }, { "type": "literal", "value": "timed out" }, { "type": "literal", "value": "error" } ] } }, { "id": 606, "name": "REALTIME_CHANNEL_STATES", "kind": 32, "kindString": "Variable", "flags": { "isConst": true }, "sources": [ { "fileName": "src/RealtimeChannel.ts", "line": 108, "character": 13 } ], "type": { "type": "query", "queryType": { "type": "reference", "name": "CHANNEL_STATES" } }, "defaultValue": "CHANNEL_STATES" } ], "groups": [ { "title": "Enumerations", "kind": 8, "children": [588, 592, 597, 601] }, { "title": "Classes", "kind": 128, "children": [64, 359, 1] }, { "title": "Type Aliases", "kind": 4194304, "children": [347, 358, 491, 510, 517, 524, 548, 529, 539, 558, 568, 578, 587] }, { "title": "Variables", "kind": 32, "children": [606] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 0, "name": "@supabase/storage-js", "kind": 1, "flags": {}, "originalName": "", "children": [ { "id": 1, "name": "index", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 449, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 450, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 17, "character": 2 } ], "signatures": [ { "id": 451, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 452, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 453, "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "id": 449, "name": "StorageApiError" }, "overwrites": { "type": "reference", "id": 446, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", "id": 445, "name": "StorageError.constructor" } }, { "id": 454, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 15, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 455, "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 23, "character": 2 } ], "signatures": [ { "id": 456, "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 457, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 459, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 26, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 458, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 25, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 460, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 27, "character": 6 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [459, 458, 460] } ] } } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [450] }, { "title": "Properties", "kind": 1024, "children": [454] }, { "title": "Methods", "kind": 2048, "children": [455] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 444, "name": "StorageError" } ] }, { "id": 304, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 305, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/StorageClient.ts", "line": 6, "character": 2 } ], "signatures": [ { "id": 306, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 307, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 308, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 309, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 310, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 311, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 312, "name": "fetch", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 314, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 315, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" } }, { "id": 316, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "id": 304, "name": "StorageClient" }, "overwrites": { "type": "reference", "id": 5, "name": "default.constructor" } } ], "overwrites": { "type": "reference", "id": 4, "name": "default.constructor" } }, { "id": 347, "name": "createBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 85, "character": 8 } ], "signatures": [ { "id": 348, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new Storage bucket", "returns": "newly created bucket id\n" }, "parameters": [ { "id": 349, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A unique identifier for the bucket you are creating." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 350, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 354, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 90, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 353, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 89, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 352, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 88, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [354, 353, 352] } ] } }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 356, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 96, "character": 8 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 399, "name": "Bucket" }, { "type": "literal", "value": "name" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 357, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 97, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [356, 357] } ] } }, { "type": "reflection", "declaration": { "id": 358, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 359, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 100, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 360, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 101, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [359, 360] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 44, "name": "default.createBucket" } } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "default.createBucket" } }, { "id": 388, "name": "deleteBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 219, "character": 8 } ], "signatures": [ { "id": 389, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." }, "parameters": [ { "id": 390, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique identifier of the bucket you would like to delete.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 392, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 223, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 394, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 223, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [394] } ] } } }, { "id": 395, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 224, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [392, 395] } ] } }, { "type": "reflection", "declaration": { "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 397, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 227, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 398, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 228, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [397, 398] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 85, "name": "default.deleteBucket" } } ], "inheritedFrom": { "type": "reference", "id": 84, "name": "default.deleteBucket" } }, { "id": 377, "name": "emptyBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 184, "character": 8 } ], "signatures": [ { "id": 378, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Removes all objects inside a single bucket." }, "parameters": [ { "id": 379, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique identifier of the bucket you would like to empty.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 381, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 188, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 383, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 188, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [383] } ] } } }, { "id": 384, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 189, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [381, 384] } ] } }, { "type": "reflection", "declaration": { "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 386, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 192, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 387, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 193, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [386, 387] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 74, "name": "default.emptyBucket" } } ], "inheritedFrom": { "type": "reference", "id": 73, "name": "default.emptyBucket" } }, { "id": 317, "name": "from", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/StorageClient.ts", "line": 15, "character": 2 } ], "signatures": [ { "id": 318, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform file operation in a bucket." }, "parameters": [ { "id": 319, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The bucket id to operate on.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 96, "name": "default" } } ] }, { "id": 338, "name": "getBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 48, "character": 8 } ], "signatures": [ { "id": 339, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves the details of an existing Storage bucket." }, "parameters": [ { "id": 340, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique identifier of the bucket you would like to retrieve.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 342, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 52, "character": 8 } ], "type": { "type": "reference", "id": 399, "name": "Bucket" } }, { "id": 343, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 53, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [342, 343] } ] } }, { "type": "reflection", "declaration": { "id": 344, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 345, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 56, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 346, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 57, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [345, 346] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 35, "name": "default.getBucket" } } ], "inheritedFrom": { "type": "reference", "id": 34, "name": "default.getBucket" } }, { "id": 330, "name": "listBuckets", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 21, "character": 8 } ], "signatures": [ { "id": 331, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves the details of all Storage buckets within an existing project." }, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 332, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 333, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 23, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 399, "name": "Bucket" } } }, { "id": 334, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 24, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [333, 334] } ] } }, { "type": "reflection", "declaration": { "id": 335, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 336, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 27, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 337, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 28, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [336, 337] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 27, "name": "default.listBuckets" } } ], "inheritedFrom": { "type": "reference", "id": 26, "name": "default.listBuckets" } }, { "id": 361, "name": "updateBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 139, "character": 8 } ], "signatures": [ { "id": 362, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates a Storage bucket" }, "parameters": [ { "id": 363, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A unique identifier for the bucket you are updating." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 364, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 368, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 144, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 367, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 143, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 366, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 142, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [368, 367, 366] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 370, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 148, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 371, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 372, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 148, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [372] } ] } } }, { "id": 373, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 149, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [370, 373] } ] } }, { "type": "reflection", "declaration": { "id": 374, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 375, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 152, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 376, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 153, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [375, 376] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 58, "name": "default.updateBucket" } } ], "inheritedFrom": { "type": "reference", "id": 57, "name": "default.updateBucket" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [305] }, { "title": "Methods", "kind": 2048, "children": [347, 388, 377, 317, 338, 330, 361] } ], "sources": [ { "fileName": "src/StorageClient.ts", "line": 5, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 3, "name": "default" } ] }, { "id": 444, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 445, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 4, "character": 2 } ], "signatures": [ { "id": 446, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 447, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 444, "name": "StorageError" }, "overwrites": { "type": "reference", "name": "Error.constructor" } } ], "overwrites": { "type": "reference", "name": "Error.constructor" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [445] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 1, "character": 13 } ], "extendedTypes": [ { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } ], "extendedBy": [ { "type": "reference", "id": 449, "name": "StorageApiError" }, { "type": "reference", "id": 462, "name": "StorageUnknownError" } ] }, { "id": 462, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 463, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 35, "character": 2 } ], "signatures": [ { "id": 464, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 465, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 466, "name": "originalError", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 462, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", "id": 446, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", "id": 445, "name": "StorageError.constructor" } }, { "id": 467, "name": "originalError", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 33, "character": 2 } ], "type": { "type": "intrinsic", "name": "unknown" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [463] }, { "title": "Properties", "kind": 1024, "children": [467] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 32, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 444, "name": "StorageError" } ] }, { "id": 399, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 404, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 6, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 405, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 7, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 403, "name": "file_size_limit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 5, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 400, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 2, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 401, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 3, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 402, "name": "owner", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 4, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 407, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 406, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [404, 405, 403, 400, 401, 402, 407, 406] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 17 } ] }, { "id": 431, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 432, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Pass in an AbortController's signal to cancel the request." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [432] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 70, "character": 17 } ] }, { "id": 408, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 410, "name": "bucket_id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 14, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 417, "name": "buckets", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 21, "character": 2 } ], "type": { "type": "reference", "id": 399, "name": "Bucket", "dereferenced": { "id": 399, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 404, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 6, "character": 2 } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 405, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 7, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 403, "name": "file_size_limit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 5, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 400, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 2, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 401, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 3, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 402, "name": "owner", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 4, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 407, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 9, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 406, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [404, 405, 403, 400, 401, 402, 407, 406] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 17 } ] } } }, { "id": 414, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 18, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 412, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 16, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 415, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 19, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 416, "name": "metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 20, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 409, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 13, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 411, "name": "owner", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 15, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 413, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 17, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [410, 417, 414, 412, 415, 416, 409, 411, 413] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 12, "character": 17 } ] }, { "id": 421, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 422, "name": "cacheControl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 33, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 423, "name": "contentType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 425, "name": "duplex", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 424, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 41, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [422, 423, 425, 424] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 29, "character": 17 } ] }, { "id": 433, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 434, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 79, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [434] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 78, "character": 17 } ] }, { "id": 426, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 427, "name": "limit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": " The number of files you want to be returned." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 428, "name": "offset", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The starting position." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 57, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 430, "name": "search", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The search string to filter files by." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "sortBy", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The column to sort by. Can be any column inside a FileObject." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 62, "character": 2 } ], "type": { "type": "reference", "id": 418, "name": "SortBy", "dereferenced": { "id": 418, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 419, "name": "column", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 25, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "order", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 26, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [419, 420] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 24, "character": 17 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [427, 428, 430, 429] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, "character": 17 } ] }, { "id": 418, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 419, "name": "column", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 25, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "order", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 26, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [419, 420] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 24, "character": 17 } ] }, { "id": 435, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 440, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Specify the format of the image requested.", "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 110, "character": 2 } ], "type": { "type": "literal", "value": "origin" } }, { "id": 437, "name": "height", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The height of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 90, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 439, "name": "quality", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 103, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 438, "name": "resize", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "cover" }, { "type": "literal", "value": "contain" }, { "type": "literal", "value": "fill" } ] } }, { "id": 436, "name": "width", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The width of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 86, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [440, 437, 439, 438, 436] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 82, "character": 17 } ] }, { "id": 441, "name": "isStorageError", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", "line": 10, "character": 16 } ], "signatures": [ { "id": 442, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 443, "name": "error", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "id": 444, "name": "StorageError" } } } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [449, 304, 444, 462] }, { "title": "Interfaces", "kind": 256, "children": [399, 431, 408, 421, 433, 426, 418, 435] }, { "title": "Functions", "kind": 64, "children": [441] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 2, "name": "packages/StorageBucketApi", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 3, "name": "default", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 4, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 12, "character": 2 } ], "signatures": [ { "id": 5, "name": "new default", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 6, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 7, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 8, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 9, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 10, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 11, "name": "fetch", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 12, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 13, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 14, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" } }, { "id": 15, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "id": 3, "name": "default" } } ] }, { "id": 43, "name": "createBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 85, "character": 8 } ], "signatures": [ { "id": 44, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a new Storage bucket", "returns": "newly created bucket id\n" }, "parameters": [ { "id": 45, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A unique identifier for the bucket you are creating." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 46, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 47, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 50, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 90, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 49, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 89, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 48, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 88, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [50, 49, 48] } ] } }, "defaultValue": "..." } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 51, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 52, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 96, "character": 8 } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 399, "name": "Bucket" }, { "type": "literal", "value": "name" } ], "qualifiedName": "Pick", "package": "typescript", "name": "Pick" } }, { "id": 53, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 97, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [52, 53] } ] } }, { "type": "reflection", "declaration": { "id": 54, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 55, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 100, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 56, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 101, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [55, 56] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 84, "name": "deleteBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 219, "character": 8 } ], "signatures": [ { "id": 85, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." }, "parameters": [ { "id": 86, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique identifier of the bucket you would like to delete.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 87, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 88, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 223, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 90, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 223, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [90] } ] } } }, { "id": 91, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 224, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [88, 91] } ] } }, { "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/packages/StorageBucketApi.ts", "line": 227, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 94, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 228, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [93, 94] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 73, "name": "emptyBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 184, "character": 8 } ], "signatures": [ { "id": 74, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Removes all objects inside a single bucket." }, "parameters": [ { "id": 75, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique identifier of the bucket you would like to empty.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 77, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 188, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 78, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 79, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 188, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [79] } ] } } }, { "id": 80, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 189, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [77, 80] } ] } }, { "type": "reflection", "declaration": { "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 82, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 192, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 83, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 193, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [82, 83] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 34, "name": "getBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 48, "character": 8 } ], "signatures": [ { "id": 35, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves the details of an existing Storage bucket." }, "parameters": [ { "id": 36, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The unique identifier of the bucket you would like to retrieve.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 37, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 38, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 52, "character": 8 } ], "type": { "type": "reference", "id": 399, "name": "Bucket" } }, { "id": 39, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 53, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [38, 39] } ] } }, { "type": "reflection", "declaration": { "id": 40, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 41, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 56, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 42, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 57, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [41, 42] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 26, "name": "listBuckets", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 21, "character": 8 } ], "signatures": [ { "id": 27, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Retrieves the details of all Storage buckets within an existing project." }, "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 28, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 29, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 23, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 399, "name": "Bucket" } } }, { "id": 30, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 24, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [29, 30] } ] } }, { "type": "reflection", "declaration": { "id": 31, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 32, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 27, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 33, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 28, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [32, 33] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 57, "name": "updateBucket", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 139, "character": 8 } ], "signatures": [ { "id": 58, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates a Storage bucket" }, "parameters": [ { "id": 59, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "A unique identifier for the bucket you are updating." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 60, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 64, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 144, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 63, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 143, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 62, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 142, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [64, 63, 62] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "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/packages/StorageBucketApi.ts", "line": 148, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 67, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 68, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 148, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [68] } ] } } }, { "id": 69, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 149, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [66, 69] } ] } }, { "type": "reflection", "declaration": { "id": 70, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 71, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 152, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 72, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 153, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [71, 72] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [4] }, { "title": "Methods", "kind": 2048, "children": [43, 84, 73, 34, 26, 57] } ], "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 7, "character": 21 } ], "extendedBy": [ { "type": "reference", "id": 304, "name": "StorageClient" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [3] } ], "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 1, "character": 0 } ] }, { "id": 95, "name": "packages/StorageFileApi", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { "id": 96, "name": "default", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 97, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 45, "character": 2 } ], "signatures": [ { "id": 98, "name": "new default", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 99, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 100, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 101, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { "id": 102, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 103, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } }, "defaultValue": "{}" }, { "id": 104, "name": "bucketId", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 105, "name": "fetch", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 107, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 108, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" } }, { "id": 109, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } } ], "type": { "type": "reference", "id": 96, "name": "default" } } ] }, { "id": 207, "name": "copy", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 338, "character": 8 } ], "signatures": [ { "id": 208, "name": "copy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Copies an existing file to a new path in the same bucket." }, "parameters": [ { "id": 209, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The original file path, including the current file name. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 210, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 212, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 343, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 213, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 214, "name": "path", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 343, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [214] } ] } } }, { "id": 215, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 344, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [212, 215] } ] } }, { "type": "reflection", "declaration": { "id": 216, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 217, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 347, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 218, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 348, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [217, 218] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 167, "name": "createSignedUploadUrl", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 223, "character": 8 } ], "signatures": [ { "id": 168, "name": "createSignedUploadUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." }, "parameters": [ { "id": 169, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The file path, including the current file name. For example `folder/image.png`.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 170, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 171, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 227, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 175, "name": "path", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 227, "character": 50 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 173, "name": "signedUrl", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 227, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 174, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 227, "character": 35 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [175, 173, 174] } ] } } }, { "id": 176, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 228, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [171, 176] } ] } }, { "type": "reflection", "declaration": { "id": 177, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 178, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 231, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 179, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 232, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [178, 179] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 219, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 376, "character": 8 } ], "signatures": [ { "id": 220, "name": "createSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." }, "parameters": [ { "id": 221, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The file path, including the current file name. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 222, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 223, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 225, "name": "download", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 379, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "boolean" } ] } }, { "id": 226, "name": "transform", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Transform the asset before serving it to the client.\n" }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 379, "character": 45 } ], "type": { "type": "reference", "id": 435, "name": "TransformOptions", "dereferenced": { "id": 435, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 440, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Specify the format of the image requested.", "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 110, "character": 2 } ], "type": { "type": "literal", "value": "origin" } }, { "id": 437, "name": "height", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The height of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 90, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 439, "name": "quality", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 103, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 438, "name": "resize", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "cover" }, { "type": "literal", "value": "contain" }, { "type": "literal", "value": "fill" } ] } }, { "id": 436, "name": "width", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The width of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 86, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [440, 437, 439, 438, 436] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 82, "character": 17 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [225, 226] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 227, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 228, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 382, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 230, "name": "signedUrl", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 382, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [230] } ] } } }, { "id": 231, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 383, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [228, 231] } ] } }, { "type": "reflection", "declaration": { "id": 232, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 233, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 386, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 234, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 387, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [233, 234] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 235, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 421, "character": 8 } ], "signatures": [ { "id": 236, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." }, "parameters": [ { "id": 237, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 238, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 239, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 241, "name": "download", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 424, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "boolean" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [241] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 243, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 427, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 244, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 245, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 427, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 246, "name": "path", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 427, "character": 38 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 247, "name": "signedUrl", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 427, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [245, 246, 247] } ] } } } }, { "id": 248, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 428, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [243, 248] } ] } }, { "type": "reflection", "declaration": { "id": 249, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 250, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 431, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 251, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 432, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [250, 251] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 252, "name": "download", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 470, "character": 8 } ], "signatures": [ { "id": 253, "name": "download", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead." }, "parameters": [ { "id": 254, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 255, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 256, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 257, "name": "transform", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Transform the asset before serving it to the client.\n" }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 472, "character": 16 } ], "type": { "type": "reference", "id": 435, "name": "TransformOptions", "dereferenced": { "id": 435, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 440, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Specify the format of the image requested.", "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 110, "character": 2 } ], "type": { "type": "literal", "value": "origin" } }, { "id": 437, "name": "height", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The height of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 90, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 439, "name": "quality", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 103, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 438, "name": "resize", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "cover" }, { "type": "literal", "value": "contain" }, { "type": "literal", "value": "fill" } ] } }, { "id": 436, "name": "width", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The width of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 86, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [440, 437, 439, 438, 436] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 82, "character": 17 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [257] } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 258, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 259, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 475, "character": 8 } ], "type": { "type": "reference", "qualifiedName": "Blob", "package": "typescript", "name": "Blob" } }, { "id": 260, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 476, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [259, 260] } ] } }, { "type": "reflection", "declaration": { "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 262, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 479, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 263, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 480, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [262, 263] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 264, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 513, "character": 2 } ], "signatures": [ { "id": 265, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." }, "parameters": [ { "id": 266, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 267, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 269, "name": "download", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 515, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "boolean" } ] } }, { "id": 270, "name": "transform", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Transform the asset before serving it to the client.\n" }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 515, "character": 45 } ], "type": { "type": "reference", "id": 435, "name": "TransformOptions", "dereferenced": { "id": 435, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 440, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Specify the format of the image requested.", "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 110, "character": 2 } ], "type": { "type": "literal", "value": "origin" } }, { "id": 437, "name": "height", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The height of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 90, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 439, "name": "quality", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 103, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 438, "name": "resize", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 97, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "cover" }, { "type": "literal", "value": "contain" }, { "type": "literal", "value": "fill" } ] } }, { "id": 436, "name": "width", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The width of the image in pixels." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 86, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [440, 437, 439, 438, 436] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 82, "character": 17 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [269, 270] } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 272, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 516, "character": 7 } ], "type": { "type": "reflection", "declaration": { "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 274, "name": "publicUrl", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 516, "character": 15 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [274] } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [272] } ] } } } ] }, { "id": 284, "name": "list", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 647, "character": 8 } ], "signatures": [ { "id": 285, "name": "list", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Lists all the files within a bucket." }, "parameters": [ { "id": 286, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The folder path.\n" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 287, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 426, "name": "SearchOptions", "dereferenced": { "id": 426, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 427, "name": "limit", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": " The number of files you want to be returned." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 428, "name": "offset", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The starting position." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 57, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 430, "name": "search", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The search string to filter files by." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 67, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "sortBy", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The column to sort by. Can be any column inside a FileObject." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 62, "character": 2 } ], "type": { "type": "reference", "id": 418, "name": "SortBy", "dereferenced": { "id": 418, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 419, "name": "column", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 25, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 420, "name": "order", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 26, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [419, 420] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 24, "character": 17 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [427, 428, 430, 429] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, "character": 17 } ] } } }, { "id": 288, "name": "parameters", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 431, "name": "FetchParameters", "dereferenced": { "id": 431, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 432, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Pass in an AbortController's signal to cancel the request." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [432] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 70, "character": 17 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 289, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 290, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 653, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 408, "name": "FileObject" } } }, { "id": 291, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 654, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [290, 291] } ] } }, { "type": "reflection", "declaration": { "id": 292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 293, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 657, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 294, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 658, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [293, 294] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 195, "name": "move", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 302, "character": 8 } ], "signatures": [ { "id": 196, "name": "move", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Moves an existing file to a new path in the same bucket." }, "parameters": [ { "id": 197, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The original file path, including the current file name. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 198, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The new file path, including the new file name. For example `folder/image-new.png`.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 199, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 200, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 307, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 202, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 307, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [202] } ] } } }, { "id": 203, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 308, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [200, 203] } ] } }, { "type": "reflection", "declaration": { "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 205, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 311, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 206, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 312, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [205, 206] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 275, "name": "remove", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 551, "character": 8 } ], "signatures": [ { "id": 276, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Deletes files within the same bucket" }, "parameters": [ { "id": 277, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 278, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 279, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 555, "character": 8 } ], "type": { "type": "array", "elementType": { "type": "reference", "id": 408, "name": "FileObject" } } }, { "id": 280, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 556, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [279, 280] } ] } }, { "type": "reflection", "declaration": { "id": 281, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 282, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 559, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 283, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 560, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [282, 283] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 180, "name": "update", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 269, "character": 8 } ], "signatures": [ { "id": 181, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Replaces an existing file at the specified path with a new one." }, "parameters": [ { "id": 182, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 183, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The body of the file to be stored in the bucket.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "qualifiedName": "ArrayBuffer", "package": "typescript", "name": "ArrayBuffer" }, { "type": "reference", "qualifiedName": "ArrayBufferView", "package": "typescript", "name": "ArrayBufferView" }, { "type": "reference", "qualifiedName": "Blob", "package": "typescript", "name": "Blob" }, { "type": "reference", "qualifiedName": "Buffer", "package": "@types/node", "name": "Buffer" }, { "type": "reference", "qualifiedName": "File", "package": "typescript", "name": "File" }, { "type": "reference", "qualifiedName": "FormData", "package": "typescript", "name": "FormData" }, { "type": "reference", "qualifiedName": "NodeJS.ReadableStream", "package": "@types/node", "name": "ReadableStream" }, { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Uint8Array", "package": "typescript", "name": "Uint8Array" } ], "qualifiedName": "ReadableStream", "package": "typescript", "name": "ReadableStream" }, { "type": "reference", "qualifiedName": "URLSearchParams", "package": "typescript", "name": "URLSearchParams" } ] } }, { "id": 184, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 421, "name": "FileOptions", "dereferenced": { "id": 421, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 422, "name": "cacheControl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 33, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 423, "name": "contentType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 425, "name": "duplex", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 424, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 41, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [422, 423, 425, 424] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 29, "character": 17 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 186, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 285, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 190, "name": "fullPath", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 285, "character": 42 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 188, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 285, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 189, "name": "path", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 285, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [190, 188, 189] } ] } } }, { "id": 191, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 286, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [186, 191] } ] } }, { "type": "reflection", "declaration": { "id": 192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 193, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 289, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 194, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 290, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [193, 194] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 137, "name": "upload", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 135, "character": 8 } ], "signatures": [ { "id": 138, "name": "upload", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Uploads a file to an existing bucket." }, "parameters": [ { "id": 139, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 140, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The body of the file to be stored in the bucket.\n" }, "type": { "type": "reference", "name": "FileBody" } }, { "id": 141, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 421, "name": "FileOptions", "dereferenced": { "id": 421, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 422, "name": "cacheControl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 33, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 423, "name": "contentType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 425, "name": "duplex", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 424, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 41, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [422, 423, 425, 424] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 29, "character": 17 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 143, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 141, "character": 8 } ], "type": { "type": "reflection", "declaration": { "id": 144, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 147, "name": "fullPath", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 141, "character": 42 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 145, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 141, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 146, "name": "path", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 141, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [147, 145, 146] } ] } } }, { "id": 148, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 142, "character": 8 } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [143, 148] } ] } }, { "type": "reflection", "declaration": { "id": 149, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 150, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 145, "character": 8 } ], "type": { "type": "literal", "value": null } }, { "id": 151, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 146, "character": 8 } ], "type": { "type": "reference", "id": 444, "name": "StorageError" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [150, 151] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 152, "name": "uploadToSignedUrl", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 158, "character": 8 } ], "signatures": [ { "id": 153, "name": "uploadToSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Upload a file with a token generated from `createSignedUploadUrl`." }, "parameters": [ { "id": 154, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 155, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The token generated from `createSignedUploadUrl`" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 156, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The body of the file to be stored in the bucket.\n" }, "type": { "type": "reference", "name": "FileBody" } }, { "id": 157, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "id": 421, "name": "FileOptions", "dereferenced": { "id": 421, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 422, "name": "cacheControl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 33, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 423, "name": "contentType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 37, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 425, "name": "duplex", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 45, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 424, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." }, "sources": [ { "fileName": "src/lib/types.ts", "line": 41, "character": 2 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [422, 423, 425, 424] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 29, "character": 17 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "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/packages/StorageFileApi.ts", "line": 201, "character": 10 } ], "type": { "type": "reflection", "declaration": { "id": 160, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 162, "name": "fullPath", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 201, "character": 35 } ], "type": { "type": "intrinsic", "name": "any" }, "defaultValue": "data.Key" }, { "id": 161, "name": "path", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 201, "character": 18 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "cleanPath" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [162, 161] } ] } }, "defaultValue": "..." }, { "id": 163, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 202, "character": 10 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [159, 163] } ] } }, { "type": "reflection", "declaration": { "id": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 165, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 206, "character": 17 } ], "type": { "type": "literal", "value": null }, "defaultValue": "null" }, { "id": 166, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [165, 166] } ] } } ] } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [97] }, { "title": "Methods", "kind": 2048, "children": [207, 167, 219, 235, 252, 264, 284, 195, 275, 180, 137, 152] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 39, "character": 21 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [96] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 2, "children": [1, 2, 95] } ] }, { "id": 0, "name": "@supabase/functions-js", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 63, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 64, "name": "Any", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 45, "character": 2 } ], "type": { "type": "literal", "value": "any" }, "defaultValue": "\"any\"" }, { "id": 65, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 46, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-1" }, "defaultValue": "\"ap-northeast-1\"" }, { "id": 66, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 47, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-2" }, "defaultValue": "\"ap-northeast-2\"" }, { "id": 67, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 48, "character": 2 } ], "type": { "type": "literal", "value": "ap-south-1" }, "defaultValue": "\"ap-south-1\"" }, { "id": 68, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 49, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-1" }, "defaultValue": "\"ap-southeast-1\"" }, { "id": 69, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 50, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-2" }, "defaultValue": "\"ap-southeast-2\"" }, { "id": 70, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 51, "character": 2 } ], "type": { "type": "literal", "value": "ca-central-1" }, "defaultValue": "\"ca-central-1\"" }, { "id": 71, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 52, "character": 2 } ], "type": { "type": "literal", "value": "eu-central-1" }, "defaultValue": "\"eu-central-1\"" }, { "id": 72, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 53, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-1" }, "defaultValue": "\"eu-west-1\"" }, { "id": 73, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-2" }, "defaultValue": "\"eu-west-2\"" }, { "id": 74, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 55, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-3" }, "defaultValue": "\"eu-west-3\"" }, { "id": 75, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 2 } ], "type": { "type": "literal", "value": "sa-east-1" }, "defaultValue": "\"sa-east-1\"" }, { "id": 76, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 57, "character": 2 } ], "type": { "type": "literal", "value": "us-east-1" }, "defaultValue": "\"us-east-1\"" }, { "id": 77, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 58, "character": 2 } ], "type": { "type": "literal", "value": "us-west-1" }, "defaultValue": "\"us-west-1\"" }, { "id": 78, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 59, "character": 2 } ], "type": { "type": "literal", "value": "us-west-2" }, "defaultValue": "\"us-west-2\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] } ], "sources": [ { "fileName": "src/types.ts", "line": 44, "character": 12 } ] }, { "id": 1, "name": "FunctionsClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 2, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 18, "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/FunctionsClient.ts", "line": 26, "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": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "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/FunctionsClient.ts", "line": 25, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 13, "name": "region", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 27, "character": 6 } ], "type": { "type": "reference", "id": 63, "name": "FunctionRegion", "dereferenced": { "id": 63, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 64, "name": "Any", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 45, "character": 2 } ], "type": { "type": "literal", "value": "any" }, "defaultValue": "\"any\"" }, { "id": 65, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 46, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-1" }, "defaultValue": "\"ap-northeast-1\"" }, { "id": 66, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 47, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-2" }, "defaultValue": "\"ap-northeast-2\"" }, { "id": 67, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 48, "character": 2 } ], "type": { "type": "literal", "value": "ap-south-1" }, "defaultValue": "\"ap-south-1\"" }, { "id": 68, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 49, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-1" }, "defaultValue": "\"ap-southeast-1\"" }, { "id": 69, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 50, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-2" }, "defaultValue": "\"ap-southeast-2\"" }, { "id": 70, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 51, "character": 2 } ], "type": { "type": "literal", "value": "ca-central-1" }, "defaultValue": "\"ca-central-1\"" }, { "id": 71, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 52, "character": 2 } ], "type": { "type": "literal", "value": "eu-central-1" }, "defaultValue": "\"eu-central-1\"" }, { "id": 72, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 53, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-1" }, "defaultValue": "\"eu-west-1\"" }, { "id": 73, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-2" }, "defaultValue": "\"eu-west-2\"" }, { "id": 74, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 55, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-3" }, "defaultValue": "\"eu-west-3\"" }, { "id": 75, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 2 } ], "type": { "type": "literal", "value": "sa-east-1" }, "defaultValue": "\"sa-east-1\"" }, { "id": 76, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 57, "character": 2 } ], "type": { "type": "literal", "value": "us-east-1" }, "defaultValue": "\"us-east-1\"" }, { "id": 77, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 58, "character": 2 } ], "type": { "type": "literal", "value": "us-west-1" }, "defaultValue": "\"us-west-1\"" }, { "id": 78, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 59, "character": 2 } ], "type": { "type": "literal", "value": "us-west-2" }, "defaultValue": "\"us-west-2\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [ 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 44, "character": 12 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [8, 7, 13] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 1, "name": "FunctionsClient" } } ] }, { "id": 17, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 18, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 19, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 20, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 21, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 15, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 14, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 16, "name": "region", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 15, "character": 12 } ], "type": { "type": "reference", "id": 63, "name": "FunctionRegion", "dereferenced": { "id": 63, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 64, "name": "Any", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 45, "character": 2 } ], "type": { "type": "literal", "value": "any" }, "defaultValue": "\"any\"" }, { "id": 65, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 46, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-1" }, "defaultValue": "\"ap-northeast-1\"" }, { "id": 66, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 47, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-2" }, "defaultValue": "\"ap-northeast-2\"" }, { "id": 67, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 48, "character": 2 } ], "type": { "type": "literal", "value": "ap-south-1" }, "defaultValue": "\"ap-south-1\"" }, { "id": 68, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 49, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-1" }, "defaultValue": "\"ap-southeast-1\"" }, { "id": 69, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 50, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-2" }, "defaultValue": "\"ap-southeast-2\"" }, { "id": 70, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 51, "character": 2 } ], "type": { "type": "literal", "value": "ca-central-1" }, "defaultValue": "\"ca-central-1\"" }, { "id": 71, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 52, "character": 2 } ], "type": { "type": "literal", "value": "eu-central-1" }, "defaultValue": "\"eu-central-1\"" }, { "id": 72, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 53, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-1" }, "defaultValue": "\"eu-west-1\"" }, { "id": 73, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-2" }, "defaultValue": "\"eu-west-2\"" }, { "id": 74, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 55, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-3" }, "defaultValue": "\"eu-west-3\"" }, { "id": 75, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 2 } ], "type": { "type": "literal", "value": "sa-east-1" }, "defaultValue": "\"sa-east-1\"" }, { "id": 76, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 57, "character": 2 } ], "type": { "type": "literal", "value": "us-east-1" }, "defaultValue": "\"us-east-1\"" }, { "id": 77, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 58, "character": 2 } ], "type": { "type": "literal", "value": "us-west-1" }, "defaultValue": "\"us-west-1\"" }, { "id": 78, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 59, "character": 2 } ], "type": { "type": "literal", "value": "us-west-2" }, "defaultValue": "\"us-west-2\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] } ], "sources": [ { "fileName": "src/types.ts", "line": 44, "character": 12 } ] } } }, { "id": 14, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 25, "name": "invoke", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 49, "character": 8 } ], "signatures": [ { "id": 26, "name": "invoke", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Invokes a function" }, "typeParameter": [ { "id": 27, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "parameters": [ { "id": 28, "name": "functionName", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The name of the Function to invoke." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 29, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Options for invoking the Function.\n" }, "type": { "type": "reference", "id": 30, "name": "FunctionInvokeOptions", "dereferenced": { "id": 30, "name": "FunctionInvokeOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 62, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 31, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 38, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The body of the request." }, "sources": [ { "fileName": "src/types.ts", "line": 78, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "File", "package": "typescript", "name": "File" }, { "type": "reference", "qualifiedName": "Blob", "package": "typescript", "name": "Blob" }, { "type": "reference", "qualifiedName": "ArrayBuffer", "package": "typescript", "name": "ArrayBuffer" }, { "type": "reference", "qualifiedName": "FormData", "package": "typescript", "name": "FormData" }, { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Uint8Array", "package": "typescript", "name": "Uint8Array" } ], "qualifiedName": "ReadableStream", "package": "typescript", "name": "ReadableStream" }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 32, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Object representing the headers to send with the request." }, "sources": [ { "fileName": "src/types.ts", "line": 66, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 33, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 66, "character": 12 } ], "indexSignature": { "id": 34, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 35, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 36, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The HTTP verb of the request" }, "sources": [ { "fileName": "src/types.ts", "line": 70, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "POST" }, { "type": "literal", "value": "GET" }, { "type": "literal", "value": "PUT" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 37, "name": "region", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Region to invoke the function in." }, "sources": [ { "fileName": "src/types.ts", "line": 74, "character": 2 } ], "type": { "type": "reference", "id": 63, "name": "FunctionRegion", "dereferenced": { "id": 63, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 64, "name": "Any", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 45, "character": 2 } ], "type": { "type": "literal", "value": "any" }, "defaultValue": "\"any\"" }, { "id": 65, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 46, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-1" }, "defaultValue": "\"ap-northeast-1\"" }, { "id": 66, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 47, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-2" }, "defaultValue": "\"ap-northeast-2\"" }, { "id": 67, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 48, "character": 2 } ], "type": { "type": "literal", "value": "ap-south-1" }, "defaultValue": "\"ap-south-1\"" }, { "id": 68, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 49, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-1" }, "defaultValue": "\"ap-southeast-1\"" }, { "id": 69, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 50, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-2" }, "defaultValue": "\"ap-southeast-2\"" }, { "id": 70, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 51, "character": 2 } ], "type": { "type": "literal", "value": "ca-central-1" }, "defaultValue": "\"ca-central-1\"" }, { "id": 71, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 52, "character": 2 } ], "type": { "type": "literal", "value": "eu-central-1" }, "defaultValue": "\"eu-central-1\"" }, { "id": 72, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 53, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-1" }, "defaultValue": "\"eu-west-1\"" }, { "id": 73, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-2" }, "defaultValue": "\"eu-west-2\"" }, { "id": 74, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 55, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-3" }, "defaultValue": "\"eu-west-3\"" }, { "id": 75, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 2 } ], "type": { "type": "literal", "value": "sa-east-1" }, "defaultValue": "\"sa-east-1\"" }, { "id": 76, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 57, "character": 2 } ], "type": { "type": "literal", "value": "us-east-1" }, "defaultValue": "\"us-east-1\"" }, { "id": 77, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 58, "character": 2 } ], "type": { "type": "literal", "value": "us-west-1" }, "defaultValue": "\"us-west-1\"" }, { "id": 78, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 59, "character": 2 } ], "type": { "type": "literal", "value": "us-west-2" }, "defaultValue": "\"us-west-2\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [ 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 44, "character": 12 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [38, 32, 36, 37] } ], "sources": [ { "fileName": "src/types.ts", "line": 62, "character": 36 } ] } } } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "reference", "id": 27, "name": "T" } ], "name": "FunctionsResponse" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] }, { "id": 22, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 40, "character": 2 } ], "signatures": [ { "id": 23, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Updates the authorization header" }, "parameters": [ { "id": 24, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "the new jwt token sent in the authorisation header\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [2] }, { "title": "Properties", "kind": 1024, "children": [17, 15, 16, 14] }, { "title": "Methods", "kind": 2048, "children": [25, 22] } ], "sources": [ { "fileName": "src/FunctionsClient.ts", "line": 12, "character": 13 } ] }, { "id": 39, "name": "FunctionsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 40, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 19, "character": 2 } ], "signatures": [ { "id": 41, "name": "new FunctionsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 42, "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 43, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "'FunctionsError'" }, { "id": 44, "name": "context", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "id": 39, "name": "FunctionsError" }, "overwrites": { "type": "reference", "name": "Error.constructor" } } ], "overwrites": { "type": "reference", "name": "Error.constructor" } }, { "id": 45, "name": "context", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 18, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [40] }, { "title": "Properties", "kind": 1024, "children": [45] } ], "sources": [ { "fileName": "src/types.ts", "line": 17, "character": 13 } ], "extendedTypes": [ { "type": "reference", "qualifiedName": "Error", "package": "typescript", "name": "Error" } ], "extendedBy": [ { "type": "reference", "id": 46, "name": "FunctionsFetchError" }, { "type": "reference", "id": 51, "name": "FunctionsHttpError" }, { "type": "reference", "id": 56, "name": "FunctionsRelayError" } ] }, { "id": 46, "name": "FunctionsFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 47, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 27, "character": 2 } ], "signatures": [ { "id": 48, "name": "new FunctionsFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 49, "name": "context", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "id": 46, "name": "FunctionsFetchError" }, "overwrites": { "type": "reference", "id": 41, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", "id": 40, "name": "FunctionsError.constructor" } }, { "id": 50, "name": "context", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 18, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" }, "inheritedFrom": { "type": "reference", "id": 45, "name": "FunctionsError.context" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [47] }, { "title": "Properties", "kind": 1024, "children": [50] } ], "sources": [ { "fileName": "src/types.ts", "line": 26, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 39, "name": "FunctionsError" } ] }, { "id": 51, "name": "FunctionsHttpError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 52, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 39, "character": 2 } ], "signatures": [ { "id": 53, "name": "new FunctionsHttpError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 54, "name": "context", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "id": 51, "name": "FunctionsHttpError" }, "overwrites": { "type": "reference", "id": 41, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", "id": 40, "name": "FunctionsError.constructor" } }, { "id": 55, "name": "context", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 18, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" }, "inheritedFrom": { "type": "reference", "id": 45, "name": "FunctionsError.context" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [52] }, { "title": "Properties", "kind": 1024, "children": [55] } ], "sources": [ { "fileName": "src/types.ts", "line": 38, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 39, "name": "FunctionsError" } ] }, { "id": 56, "name": "FunctionsRelayError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 57, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 33, "character": 2 } ], "signatures": [ { "id": 58, "name": "new FunctionsRelayError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { "id": 59, "name": "context", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "id": 56, "name": "FunctionsRelayError" }, "overwrites": { "type": "reference", "id": 41, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", "id": 40, "name": "FunctionsError.constructor" } }, { "id": 60, "name": "context", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 18, "character": 2 } ], "type": { "type": "intrinsic", "name": "any" }, "inheritedFrom": { "type": "reference", "id": 45, "name": "FunctionsError.context" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [57] }, { "title": "Properties", "kind": 1024, "children": [60] } ], "sources": [ { "fileName": "src/types.ts", "line": 32, "character": 13 } ], "extendedTypes": [ { "type": "reference", "id": 39, "name": "FunctionsError" } ] }, { "id": 30, "name": "FunctionInvokeOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 62, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 31, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 38, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The body of the request." }, "sources": [ { "fileName": "src/types.ts", "line": 78, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "File", "package": "typescript", "name": "File" }, { "type": "reference", "qualifiedName": "Blob", "package": "typescript", "name": "Blob" }, { "type": "reference", "qualifiedName": "ArrayBuffer", "package": "typescript", "name": "ArrayBuffer" }, { "type": "reference", "qualifiedName": "FormData", "package": "typescript", "name": "FormData" }, { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Uint8Array", "package": "typescript", "name": "Uint8Array" } ], "qualifiedName": "ReadableStream", "package": "typescript", "name": "ReadableStream" }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 32, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Object representing the headers to send with the request." }, "sources": [ { "fileName": "src/types.ts", "line": 66, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 33, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 66, "character": 12 } ], "indexSignature": { "id": 34, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { "id": 35, "name": "key", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } } } }, { "id": 36, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The HTTP verb of the request" }, "sources": [ { "fileName": "src/types.ts", "line": 70, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "POST" }, { "type": "literal", "value": "GET" }, { "type": "literal", "value": "PUT" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 37, "name": "region", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The Region to invoke the function in." }, "sources": [ { "fileName": "src/types.ts", "line": 74, "character": 2 } ], "type": { "type": "reference", "id": 63, "name": "FunctionRegion", "dereferenced": { "id": 63, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { "id": 64, "name": "Any", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 45, "character": 2 } ], "type": { "type": "literal", "value": "any" }, "defaultValue": "\"any\"" }, { "id": 65, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 46, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-1" }, "defaultValue": "\"ap-northeast-1\"" }, { "id": 66, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 47, "character": 2 } ], "type": { "type": "literal", "value": "ap-northeast-2" }, "defaultValue": "\"ap-northeast-2\"" }, { "id": 67, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 48, "character": 2 } ], "type": { "type": "literal", "value": "ap-south-1" }, "defaultValue": "\"ap-south-1\"" }, { "id": 68, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 49, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-1" }, "defaultValue": "\"ap-southeast-1\"" }, { "id": 69, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 50, "character": 2 } ], "type": { "type": "literal", "value": "ap-southeast-2" }, "defaultValue": "\"ap-southeast-2\"" }, { "id": 70, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 51, "character": 2 } ], "type": { "type": "literal", "value": "ca-central-1" }, "defaultValue": "\"ca-central-1\"" }, { "id": 71, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 52, "character": 2 } ], "type": { "type": "literal", "value": "eu-central-1" }, "defaultValue": "\"eu-central-1\"" }, { "id": 72, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 53, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-1" }, "defaultValue": "\"eu-west-1\"" }, { "id": 73, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-2" }, "defaultValue": "\"eu-west-2\"" }, { "id": 74, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 55, "character": 2 } ], "type": { "type": "literal", "value": "eu-west-3" }, "defaultValue": "\"eu-west-3\"" }, { "id": 75, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 2 } ], "type": { "type": "literal", "value": "sa-east-1" }, "defaultValue": "\"sa-east-1\"" }, { "id": 76, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 57, "character": 2 } ], "type": { "type": "literal", "value": "us-east-1" }, "defaultValue": "\"us-east-1\"" }, { "id": 77, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 58, "character": 2 } ], "type": { "type": "literal", "value": "us-west-1" }, "defaultValue": "\"us-west-1\"" }, { "id": 78, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 59, "character": 2 } ], "type": { "type": "literal", "value": "us-west-2" }, "defaultValue": "\"us-west-2\"" } ], "groups": [ { "title": "Enumeration Members", "kind": 16, "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] } ], "sources": [ { "fileName": "src/types.ts", "line": 44, "character": 12 } ] } } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [38, 32, 36, 37] } ], "sources": [ { "fileName": "src/types.ts", "line": 62, "character": 36 } ] } } }, { "id": 61, "name": "FunctionsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 15, "character": 12 } ], "typeParameter": [ { "id": 62, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "union", "types": [null, null] } } ], "groups": [ { "title": "Enumerations", "kind": 8, "children": [63] }, { "title": "Classes", "kind": 128, "children": [1, 39, 46, 51, 56] }, { "title": "Type Aliases", "kind": 4194304, "children": [30, 61] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] } ] }