102805 lines
4.3 MiB
102805 lines
4.3 MiB
{
|
|
"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": 211,
|
|
"name": "QueryData",
|
|
"kind": 16777216,
|
|
"kindString": "Reference",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 20,
|
|
"character": 50
|
|
}
|
|
],
|
|
"target": 106
|
|
},
|
|
{
|
|
"id": 212,
|
|
"name": "QueryError",
|
|
"kind": 16777216,
|
|
"kindString": "Reference",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 20,
|
|
"character": 61
|
|
}
|
|
],
|
|
"target": 110
|
|
},
|
|
{
|
|
"id": 210,
|
|
"name": "QueryResult",
|
|
"kind": 16777216,
|
|
"kindString": "Reference",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 20,
|
|
"character": 37
|
|
}
|
|
],
|
|
"target": 104
|
|
},
|
|
{
|
|
"id": 209,
|
|
"name": "SupabaseClientOptions",
|
|
"kind": 16777216,
|
|
"kindString": "Reference",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 20,
|
|
"character": 14
|
|
}
|
|
],
|
|
"target": 60
|
|
},
|
|
{
|
|
"id": 113,
|
|
"name": "SupabaseClient",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Supabase Client.",
|
|
"text": "An isomorphic Javascript client for interacting with Postgres.\n"
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 114,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 115,
|
|
"name": "new SupabaseClient",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Create a new client for use in the browser."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 116,
|
|
"name": "Database",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 117,
|
|
"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": 116,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "literal",
|
|
"value": "public"
|
|
},
|
|
"falseType": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 118,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 99,
|
|
"name": "GenericSchema"
|
|
},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 117,
|
|
"name": "SchemaName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"extendsType": {
|
|
"type": "reference",
|
|
"id": 99,
|
|
"name": "GenericSchema"
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
"objectType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 119,
|
|
"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": 120,
|
|
"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": 121,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 60,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 117,
|
|
"name": "SchemaName"
|
|
}
|
|
],
|
|
"name": "SupabaseClientOptions",
|
|
"dereferenced": {
|
|
"id": 60,
|
|
"name": "SupabaseClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 61,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 65,
|
|
"name": "auth",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 66,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 67,
|
|
"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": 73,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 70,
|
|
"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": 72,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 74,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 69,
|
|
"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": 71,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 68,
|
|
"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": [
|
|
67,
|
|
73,
|
|
70,
|
|
72,
|
|
74,
|
|
69,
|
|
71,
|
|
68
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 62,
|
|
"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": 63,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 64,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 16,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
64
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 15,
|
|
"character": 7
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 76,
|
|
"name": "global",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 77,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 78,
|
|
"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": 59,
|
|
"name": "Fetch",
|
|
"dereferenced": {
|
|
"id": 59,
|
|
"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": 18,
|
|
"qualifiedName": "fetch",
|
|
"package": "typescript",
|
|
"name": "fetch"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 79,
|
|
"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": [
|
|
78,
|
|
79
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 11
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 75,
|
|
"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": [
|
|
65,
|
|
62,
|
|
76,
|
|
75
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 48
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 113,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 117,
|
|
"name": "SchemaName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 118,
|
|
"name": "Schema"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 122,
|
|
"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": 55,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "SupabaseAuthClient"
|
|
}
|
|
},
|
|
{
|
|
"id": 125,
|
|
"name": "authUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 59,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 135,
|
|
"name": "changedAccessToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 65,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 130,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 64,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 131,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 132,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 133,
|
|
"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": 134,
|
|
"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": 127,
|
|
"name": "functionsUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 61,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 136,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 67,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 137,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 138,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 139,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 123,
|
|
"name": "realtime",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "RealtimeClient",
|
|
"package": "@supabase/realtime-js",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 124,
|
|
"name": "realtimeUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 58,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 128,
|
|
"name": "rest",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 117,
|
|
"name": "SchemaName"
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 117,
|
|
"name": "SchemaName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"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": 129,
|
|
"name": "storageKey",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 63,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 126,
|
|
"name": "storageUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 60,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 141,
|
|
"name": "supabaseKey",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 140,
|
|
"name": "supabaseUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 142,
|
|
"name": "functions",
|
|
"kind": 262144,
|
|
"kindString": "Accessor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 132,
|
|
"character": 6
|
|
}
|
|
],
|
|
"getSignature": [
|
|
{
|
|
"id": 143,
|
|
"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": 144,
|
|
"name": "storage",
|
|
"kind": 262144,
|
|
"kindString": "Accessor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 142,
|
|
"character": 6
|
|
}
|
|
],
|
|
"getSignature": [
|
|
{
|
|
"id": 145,
|
|
"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": 184,
|
|
"name": "_getAccessToken",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {
|
|
"isPrivate": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 259,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 185,
|
|
"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": 201,
|
|
"name": "_handleTokenChanged",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {
|
|
"isPrivate": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 310,
|
|
"character": 10
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 202,
|
|
"name": "_handleTokenChanged",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 203,
|
|
"name": "event",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "AuthChangeEvent",
|
|
"package": "@supabase/gotrue-js",
|
|
"name": "AuthChangeEvent"
|
|
}
|
|
},
|
|
{
|
|
"id": 204,
|
|
"name": "source",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "CLIENT"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "STORAGE"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 205,
|
|
"name": "token",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 195,
|
|
"name": "_initRealtimeClient",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {
|
|
"isPrivate": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 296,
|
|
"character": 10
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 196,
|
|
"name": "_initRealtimeClient",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 197,
|
|
"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": 186,
|
|
"name": "_initSupabaseAuthClient",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {
|
|
"isPrivate": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 265,
|
|
"character": 10
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 187,
|
|
"name": "_initSupabaseAuthClient",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 188,
|
|
"name": "__namedParameters",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 58,
|
|
"name": "SupabaseAuthClientOptions",
|
|
"dereferenced": {
|
|
"id": 58,
|
|
"name": "SupabaseAuthClientOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 7,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "GoTrueClientOptions"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 189,
|
|
"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": 190,
|
|
"name": "fetch",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 191,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 192,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 193,
|
|
"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": 194,
|
|
"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": 198,
|
|
"name": "_listenForAuthEvents",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {
|
|
"isPrivate": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 303,
|
|
"character": 10
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 199,
|
|
"name": "_listenForAuthEvents",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 200,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 173,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 231,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 174,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 175,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The name of the Realtime channel."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 176,
|
|
"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": 146,
|
|
"name": "from",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 146,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 147,
|
|
"name": "from",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a query on a table or a view."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 148,
|
|
"name": "TableName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 149,
|
|
"name": "Table",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 81,
|
|
"name": "GenericTable"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 150,
|
|
"name": "relation",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The table or view name to query\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "TableName",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 118,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Table"
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Table"
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 151,
|
|
"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": 152,
|
|
"name": "from",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a query on a table or a view."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 153,
|
|
"name": "ViewName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 154,
|
|
"name": "View",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 94,
|
|
"name": "GenericView"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 155,
|
|
"name": "relation",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The table or view name to query\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 153,
|
|
"name": "ViewName",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 118,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 154,
|
|
"name": "View"
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 154,
|
|
"name": "View"
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 156,
|
|
"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": 157,
|
|
"name": "from",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a query on a table or a view."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 158,
|
|
"name": "relation",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The table or view name to query\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 118,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "PostgrestQueryBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 177,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 238,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 178,
|
|
"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": 182,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 255,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 183,
|
|
"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": 179,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 248,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 180,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes Realtime channel from Realtime client."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 181,
|
|
"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": 163,
|
|
"name": "rpc",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 202,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 164,
|
|
"name": "rpc",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a function call."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 165,
|
|
"name": "FunctionName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 166,
|
|
"name": "Function_",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 95,
|
|
"name": "GenericFunction"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 167,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The function name to call"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 165,
|
|
"name": "FunctionName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 168,
|
|
"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": 166,
|
|
"name": "Function_"
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 169,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 170,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 172,
|
|
"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": 210,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "exact"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "planned"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "estimated"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 171,
|
|
"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": 209,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
172,
|
|
171
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 118,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Returns"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 166,
|
|
"name": "Function_"
|
|
}
|
|
},
|
|
"extendsType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"objectType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
"objectType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
},
|
|
"extendsType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
"objectType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Returns"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 166,
|
|
"name": "Function_"
|
|
}
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 159,
|
|
"name": "schema",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 171,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 160,
|
|
"name": "schema",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a query on a schema distinct from the default schema supplied via\nthe `options.db.schema` constructor parameter.",
|
|
"text": "The schema needs to be on the list of exposed schemas inside Supabase.\n"
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 161,
|
|
"name": "DynamicSchema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 162,
|
|
"name": "schema",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The name of the schema to query\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 161,
|
|
"name": "DynamicSchema",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 161,
|
|
"name": "DynamicSchema"
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 161,
|
|
"name": "DynamicSchema"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"extendsType": {
|
|
"type": "reference",
|
|
"id": 99,
|
|
"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": [
|
|
114
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
122,
|
|
125,
|
|
135,
|
|
130,
|
|
127,
|
|
136,
|
|
123,
|
|
124,
|
|
128,
|
|
129,
|
|
126,
|
|
141,
|
|
140
|
|
]
|
|
},
|
|
{
|
|
"title": "Accessors",
|
|
"kind": 262144,
|
|
"children": [
|
|
142,
|
|
144
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
184,
|
|
201,
|
|
195,
|
|
186,
|
|
198,
|
|
173,
|
|
146,
|
|
177,
|
|
182,
|
|
179,
|
|
163,
|
|
159
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/SupabaseClient.ts",
|
|
"line": 43,
|
|
"character": 21
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 206,
|
|
"name": "Database",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 207,
|
|
"name": "SchemaName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "literal",
|
|
"value": "public"
|
|
},
|
|
"extendsType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "literal",
|
|
"value": "public"
|
|
},
|
|
"falseType": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 208,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 99,
|
|
"name": "GenericSchema"
|
|
},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 117,
|
|
"name": "SchemaName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"extendsType": {
|
|
"type": "reference",
|
|
"id": 99,
|
|
"name": "GenericSchema"
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 117,
|
|
"name": "SchemaName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 116,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "createClient",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 25,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 3,
|
|
"name": "createClient",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Creates a new Supabase Client."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 4,
|
|
"name": "Database",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 5,
|
|
"name": "SchemaName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "literal",
|
|
"value": "public"
|
|
},
|
|
"extendsType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"id": 4,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "literal",
|
|
"value": "public"
|
|
},
|
|
"falseType": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"id": 4,
|
|
"name": "Database"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 6,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 99,
|
|
"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": 99,
|
|
"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": 60,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 5,
|
|
"name": "SchemaName"
|
|
}
|
|
],
|
|
"name": "SupabaseClientOptions",
|
|
"dereferenced": {
|
|
"id": 60,
|
|
"name": "SupabaseClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 61,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 65,
|
|
"name": "auth",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 66,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 67,
|
|
"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": 73,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 70,
|
|
"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": 72,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 74,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 69,
|
|
"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": 71,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 68,
|
|
"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": [
|
|
67,
|
|
73,
|
|
70,
|
|
72,
|
|
74,
|
|
69,
|
|
71,
|
|
68
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 62,
|
|
"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": 63,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 64,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 16,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
64
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 15,
|
|
"character": 7
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 76,
|
|
"name": "global",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 77,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 78,
|
|
"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": 59,
|
|
"name": "Fetch",
|
|
"dereferenced": {
|
|
"id": 59,
|
|
"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": 18,
|
|
"qualifiedName": "fetch",
|
|
"package": "typescript",
|
|
"name": "fetch"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 79,
|
|
"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": [
|
|
78,
|
|
79
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 11
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 75,
|
|
"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": [
|
|
65,
|
|
62,
|
|
76,
|
|
75
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 48
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 113,
|
|
"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": [
|
|
211,
|
|
212,
|
|
210,
|
|
209
|
|
]
|
|
},
|
|
{
|
|
"title": "Classes",
|
|
"kind": 128,
|
|
"children": [
|
|
113
|
|
]
|
|
},
|
|
{
|
|
"title": "Functions",
|
|
"kind": 64,
|
|
"children": [
|
|
2
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 1,
|
|
"character": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 10,
|
|
"name": "lib/constants",
|
|
"kind": 2,
|
|
"kindString": "Module",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 11,
|
|
"name": "DEFAULT_HEADERS",
|
|
"kind": 32,
|
|
"kindString": "Variable",
|
|
"flags": {
|
|
"isConst": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/constants.ts",
|
|
"line": 14,
|
|
"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": 14,
|
|
"character": 33
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
13
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Variables",
|
|
"kind": 32,
|
|
"children": [
|
|
11
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/constants.ts",
|
|
"line": 2,
|
|
"character": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 14,
|
|
"name": "lib/fetch",
|
|
"kind": 2,
|
|
"kindString": "Module",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 28,
|
|
"name": "fetchWithAuth",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/fetch.ts",
|
|
"line": 26,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 29,
|
|
"name": "fetchWithAuth",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 30,
|
|
"name": "supabaseKey",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 31,
|
|
"name": "getAccessToken",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"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": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 34,
|
|
"name": "customFetch",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 35,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 36,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 37,
|
|
"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": 38,
|
|
"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": 39,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 40,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 41,
|
|
"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": 42,
|
|
"name": "init",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInit",
|
|
"package": "typescript",
|
|
"name": "RequestInit"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Response",
|
|
"package": "typescript",
|
|
"name": "Response"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "resolveFetch",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/fetch.ts",
|
|
"line": 6,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 16,
|
|
"name": "resolveFetch",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 17,
|
|
"name": "customFetch",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 18,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 19,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 20,
|
|
"name": "input",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "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"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 22,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 23,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 24,
|
|
"name": "input",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInfo",
|
|
"package": "typescript",
|
|
"name": "RequestInfo"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 25,
|
|
"name": "init",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInit",
|
|
"package": "typescript",
|
|
"name": "RequestInit"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Response",
|
|
"package": "typescript",
|
|
"name": "Response"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 26,
|
|
"name": "resolveHeadersConstructor",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/fetch.ts",
|
|
"line": 18,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 27,
|
|
"name": "resolveHeadersConstructor",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Functions",
|
|
"kind": 64,
|
|
"children": [
|
|
28,
|
|
15,
|
|
26
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/fetch.ts",
|
|
"line": 2,
|
|
"character": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 43,
|
|
"name": "lib/helpers",
|
|
"kind": 2,
|
|
"kindString": "Module",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 49,
|
|
"name": "applySettingDefaults",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/helpers.ts",
|
|
"line": 18,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 50,
|
|
"name": "applySettingDefaults",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 51,
|
|
"name": "Database",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 52,
|
|
"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": 51,
|
|
"name": "Database"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "literal",
|
|
"value": "public"
|
|
},
|
|
"falseType": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"id": 51,
|
|
"name": "Database"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 53,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 60,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 52,
|
|
"name": "SchemaName"
|
|
}
|
|
],
|
|
"name": "SupabaseClientOptions",
|
|
"dereferenced": {
|
|
"id": 60,
|
|
"name": "SupabaseClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 61,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 65,
|
|
"name": "auth",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 66,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 67,
|
|
"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": 73,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 70,
|
|
"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": 72,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 74,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 69,
|
|
"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": 71,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 68,
|
|
"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": [
|
|
67,
|
|
73,
|
|
70,
|
|
72,
|
|
74,
|
|
69,
|
|
71,
|
|
68
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 62,
|
|
"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": 63,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 64,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 16,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
64
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 15,
|
|
"character": 7
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 76,
|
|
"name": "global",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 77,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 78,
|
|
"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": 59,
|
|
"name": "Fetch",
|
|
"dereferenced": {
|
|
"id": 59,
|
|
"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": 18,
|
|
"qualifiedName": "fetch",
|
|
"package": "typescript",
|
|
"name": "fetch"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 79,
|
|
"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": [
|
|
78,
|
|
79
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 11
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 75,
|
|
"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": [
|
|
65,
|
|
62,
|
|
76,
|
|
75
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 48
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 54,
|
|
"name": "defaults",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 60,
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "SupabaseClientOptions",
|
|
"dereferenced": {
|
|
"id": 60,
|
|
"name": "SupabaseClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 61,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 65,
|
|
"name": "auth",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 66,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 67,
|
|
"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": 73,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 70,
|
|
"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": 72,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 74,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 69,
|
|
"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": 71,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 68,
|
|
"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": [
|
|
67,
|
|
73,
|
|
70,
|
|
72,
|
|
74,
|
|
69,
|
|
71,
|
|
68
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 62,
|
|
"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": 63,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 64,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 16,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
64
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 15,
|
|
"character": 7
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 76,
|
|
"name": "global",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 77,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 78,
|
|
"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": 59,
|
|
"name": "Fetch",
|
|
"dereferenced": {
|
|
"id": 59,
|
|
"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": 18,
|
|
"qualifiedName": "fetch",
|
|
"package": "typescript",
|
|
"name": "fetch"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 79,
|
|
"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": [
|
|
78,
|
|
79
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 11
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 75,
|
|
"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": [
|
|
65,
|
|
62,
|
|
76,
|
|
75
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 48
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 60,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 52,
|
|
"name": "SchemaName"
|
|
}
|
|
],
|
|
"name": "SupabaseClientOptions"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 55,
|
|
"name": "isBrowser",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/helpers.ts",
|
|
"line": 16,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 56,
|
|
"name": "isBrowser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 46,
|
|
"name": "stripTrailingSlash",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/helpers.ts",
|
|
"line": 12,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 47,
|
|
"name": "stripTrailingSlash",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 48,
|
|
"name": "url",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 44,
|
|
"name": "uuid",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/helpers.ts",
|
|
"line": 4,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 45,
|
|
"name": "uuid",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Functions",
|
|
"kind": 64,
|
|
"children": [
|
|
49,
|
|
55,
|
|
46,
|
|
44
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/helpers.ts",
|
|
"line": 2,
|
|
"character": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 57,
|
|
"name": "lib/types",
|
|
"kind": 2,
|
|
"kindString": "Module",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 58,
|
|
"name": "SupabaseAuthClientOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 7,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "GoTrueClientOptions"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 59,
|
|
"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": 18,
|
|
"qualifiedName": "fetch",
|
|
"package": "typescript",
|
|
"name": "fetch"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 95,
|
|
"name": "GenericFunction",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 89,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 96,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 97,
|
|
"name": "Args",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 90,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 98,
|
|
"name": "Returns",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 91,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
97,
|
|
98
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 89,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 91,
|
|
"name": "GenericNonUpdatableView",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 83,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 92,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 93,
|
|
"name": "Row",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 84,
|
|
"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": [
|
|
93
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 83,
|
|
"character": 38
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 99,
|
|
"name": "GenericSchema",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 94,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 100,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 103,
|
|
"name": "Functions",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 97,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 95,
|
|
"name": "GenericFunction"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 101,
|
|
"name": "Tables",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 95,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 81,
|
|
"name": "GenericTable"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 102,
|
|
"name": "Views",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 96,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 94,
|
|
"name": "GenericView"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
103,
|
|
101,
|
|
102
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 94,
|
|
"character": 28
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 81,
|
|
"name": "GenericTable",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 71,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 82,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 84,
|
|
"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": 83,
|
|
"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": 85,
|
|
"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": [
|
|
84,
|
|
83,
|
|
85
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 71,
|
|
"character": 27
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 86,
|
|
"name": "GenericUpdatableView",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 87,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 89,
|
|
"name": "Insert",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 88,
|
|
"name": "Row",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 90,
|
|
"name": "Update",
|
|
"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": [
|
|
89,
|
|
88,
|
|
90
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 94,
|
|
"name": "GenericView",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 87,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 86,
|
|
"name": "GenericUpdatableView",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 87,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 89,
|
|
"name": "Insert",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 88,
|
|
"name": "Row",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 90,
|
|
"name": "Update",
|
|
"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": [
|
|
89,
|
|
88,
|
|
90
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 91,
|
|
"name": "GenericNonUpdatableView",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 83,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 92,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 93,
|
|
"name": "Row",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 84,
|
|
"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": [
|
|
93
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 83,
|
|
"character": 38
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 106,
|
|
"name": "QueryData",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 104,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 109,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 109,
|
|
"name": "T"
|
|
},
|
|
"extendsType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 107,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 108,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 104,
|
|
"character": 51
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "inferred",
|
|
"name": "U"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
108
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 104,
|
|
"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": 110,
|
|
"name": "QueryError",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 105,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "PostgrestError",
|
|
"package": "@supabase/postgrest-js",
|
|
"name": "PostgrestError"
|
|
}
|
|
},
|
|
{
|
|
"id": 104,
|
|
"name": "QueryResult",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Helper types for query results."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 103,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 105,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 105,
|
|
"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": 60,
|
|
"name": "SupabaseClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 61,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 65,
|
|
"name": "auth",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 66,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 67,
|
|
"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": 73,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 70,
|
|
"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": 72,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 74,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 69,
|
|
"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": 71,
|
|
"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": 58,
|
|
"name": "SupabaseAuthClientOptions"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 68,
|
|
"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": [
|
|
67,
|
|
73,
|
|
70,
|
|
72,
|
|
74,
|
|
69,
|
|
71,
|
|
68
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 19,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 62,
|
|
"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": 63,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 64,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 16,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 80,
|
|
"name": "SchemaName",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
64
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 15,
|
|
"character": 7
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 76,
|
|
"name": "global",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 77,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 78,
|
|
"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": 59,
|
|
"name": "Fetch",
|
|
"dereferenced": {
|
|
"id": 59,
|
|
"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": 18,
|
|
"qualifiedName": "fetch",
|
|
"package": "typescript",
|
|
"name": "fetch"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 79,
|
|
"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": [
|
|
78,
|
|
79
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 11
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 75,
|
|
"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": [
|
|
65,
|
|
62,
|
|
76,
|
|
75
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 11,
|
|
"character": 48
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Interfaces",
|
|
"kind": 256,
|
|
"children": [
|
|
58
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"kind": 4194304,
|
|
"children": [
|
|
59,
|
|
95,
|
|
91,
|
|
99,
|
|
81,
|
|
86,
|
|
94,
|
|
106,
|
|
110,
|
|
104,
|
|
60
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1,
|
|
"character": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 111,
|
|
"name": "lib/version",
|
|
"kind": 2,
|
|
"kindString": "Module",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 112,
|
|
"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": [
|
|
112
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/version.ts",
|
|
"line": 1,
|
|
"character": 0
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Modules",
|
|
"kind": 2,
|
|
"children": [
|
|
1,
|
|
10,
|
|
14,
|
|
43,
|
|
57,
|
|
111
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 0,
|
|
"name": "@supabase/gotrue-js",
|
|
"kind": 1,
|
|
"kindString": "Project",
|
|
"flags": {},
|
|
"originalName": "",
|
|
"children": [
|
|
{
|
|
"id": 1017,
|
|
"name": "AuthApiError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1018,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1019,
|
|
"name": "new AuthApiError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1020,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1021,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1017,
|
|
"name": "AuthApiError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1012,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1011,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1022,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 17,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1015,
|
|
"name": "AuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1023,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 25,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1024,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1025,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1027,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 28,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1026,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 27,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1028,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 29,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1027,
|
|
1026,
|
|
1028
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1018
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1022
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1023
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 16,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1010,
|
|
"name": "AuthError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1011,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 5,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1012,
|
|
"name": "new AuthError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1013,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1014,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1015,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 2,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1011
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1015
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 1,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Error",
|
|
"package": "typescript",
|
|
"name": "Error"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1017,
|
|
"name": "AuthApiError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1030,
|
|
"name": "AuthUnknownError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1090,
|
|
"name": "AuthImplicitGrantRedirectError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1091,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1092,
|
|
"name": "new AuthImplicitGrantRedirectError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1093,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1094,
|
|
"name": "details",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1095,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1097,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 86,
|
|
"character": 57
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1096,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 86,
|
|
"character": 42
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1097,
|
|
1096
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1090,
|
|
"name": "AuthImplicitGrantRedirectError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1040,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1039,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1098,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1099,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1101,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 85,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1100,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 85,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1101,
|
|
1100
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 1112,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1113,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1045,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1102,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 91,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1103,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1104,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1108,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 96,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1109,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1111,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 85,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1110,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 85,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1111,
|
|
1110
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1106,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 94,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1105,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 93,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1107,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 95,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1108,
|
|
1106,
|
|
1105,
|
|
1107
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1047,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1046,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1091
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1098,
|
|
1112,
|
|
1113
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1102
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 84,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1077,
|
|
"name": "AuthInvalidCredentialsError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1078,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1079,
|
|
"name": "new AuthInvalidCredentialsError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1080,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1077,
|
|
"name": "AuthInvalidCredentialsError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1040,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1039,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1082,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1045,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1083,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1084,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1085,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1087,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 60,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 59,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1088,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 61,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1087,
|
|
1086,
|
|
1088
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1047,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1046,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1078
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1081,
|
|
1082
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1083
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 78,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1065,
|
|
"name": "AuthInvalidTokenResponseError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1066,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1067,
|
|
"name": "new AuthInvalidTokenResponseError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1065,
|
|
"name": "AuthInvalidTokenResponseError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1040,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1039,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1068,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1069,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1045,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1070,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1071,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1072,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1074,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 60,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1073,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 59,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1075,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 61,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1074,
|
|
1073,
|
|
1075
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1047,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1046,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1066
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1068,
|
|
1069
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1070
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 72,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1115,
|
|
"name": "AuthPKCEGrantCodeExchangeError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1116,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 103,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1117,
|
|
"name": "new AuthPKCEGrantCodeExchangeError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1118,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1119,
|
|
"name": "details",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1120,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1122,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 103,
|
|
"character": 57
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1121,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 103,
|
|
"character": 42
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1122,
|
|
1121
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1115,
|
|
"name": "AuthPKCEGrantCodeExchangeError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1040,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1039,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1123,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 102,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1124,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1126,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 102,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1125,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 102,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1126,
|
|
1125
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 1137,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1138,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1045,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1127,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 108,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1128,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1129,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1133,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 113,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1134,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1136,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 102,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1135,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 102,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1136,
|
|
1135
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1131,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 111,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1130,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 110,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1132,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 112,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1133,
|
|
1131,
|
|
1130,
|
|
1132
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1047,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1046,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1116
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1123,
|
|
1137,
|
|
1138
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1127
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 101,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1140,
|
|
"name": "AuthRetryableFetchError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1141,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 119,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1142,
|
|
"name": "new AuthRetryableFetchError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1143,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1144,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1140,
|
|
"name": "AuthRetryableFetchError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1040,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1039,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1145,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1146,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1045,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1147,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1148,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1149,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1151,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 60,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1150,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 59,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1152,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 61,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1151,
|
|
1150,
|
|
1152
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1047,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1046,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1141
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1145,
|
|
1146
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1147
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 118,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1053,
|
|
"name": "AuthSessionMissingError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1054,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 67,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1055,
|
|
"name": "new AuthSessionMissingError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1053,
|
|
"name": "AuthSessionMissingError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1040,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1039,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1056,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1057,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1045,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1058,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1059,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1060,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1062,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 60,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1061,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 59,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1063,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 61,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1062,
|
|
1061,
|
|
1063
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1047,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1046,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1054
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1056,
|
|
1057
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1058
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 66,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1030,
|
|
"name": "AuthUnknownError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1031,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 41,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1032,
|
|
"name": "new AuthUnknownError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1033,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1034,
|
|
"name": "originalError",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1030,
|
|
"name": "AuthUnknownError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1012,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1011,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1035,
|
|
"name": "originalError",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 39,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 1036,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 2,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1015,
|
|
"name": "AuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1031
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1035,
|
|
1036
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 38,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1154,
|
|
"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": 1155,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 139,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1156,
|
|
"name": "new AuthWeakPasswordError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1157,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1158,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1159,
|
|
"name": "reasons",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1154,
|
|
"name": "AuthWeakPasswordError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1040,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1039,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1161,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1160,
|
|
"name": "reasons",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Reasons why the password is deemed weak."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 137,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1162,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1045,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1163,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1164,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1165,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1167,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 60,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1166,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 59,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1168,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 61,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1167,
|
|
1166,
|
|
1168
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1047,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1046,
|
|
"name": "CustomAuthError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1155
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1161,
|
|
1160,
|
|
1162
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1163
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 133,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1038,
|
|
"name": "CustomAuthError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1039,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 51,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1040,
|
|
"name": "new CustomAuthError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1041,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1042,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1043,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1038,
|
|
"name": "CustomAuthError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1012,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1011,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1044,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "AuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1045,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 50,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1015,
|
|
"name": "AuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1046,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1047,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1048,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1050,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 60,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1049,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 59,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1051,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 61,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1050,
|
|
1049,
|
|
1051
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
1039
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
1044,
|
|
1045
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
1046
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 48,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1053,
|
|
"name": "AuthSessionMissingError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1065,
|
|
"name": "AuthInvalidTokenResponseError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1077,
|
|
"name": "AuthInvalidCredentialsError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1090,
|
|
"name": "AuthImplicitGrantRedirectError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1115,
|
|
"name": "AuthPKCEGrantCodeExchangeError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1140,
|
|
"name": "AuthRetryableFetchError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1154,
|
|
"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": 966,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"dereferenced": {
|
|
"id": 966,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication administration API.",
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 970,
|
|
"name": "deleteFactor",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 971,
|
|
"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": 972,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 950,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"dereferenced": {
|
|
"id": 950,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 951,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 952,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 980,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 953,
|
|
"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": 983,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
952,
|
|
953
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 941,
|
|
"name": "AuthMFAAdminDeleteFactorResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 967,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 968,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Lists all factors associated to a user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 969,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 963,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"dereferenced": {
|
|
"id": 963,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 964,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 965,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1004,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
965
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 954,
|
|
"name": "AuthMFAAdminListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
970,
|
|
967
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1012,
|
|
"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": 645,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 645,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 647,
|
|
"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": 357,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 650,
|
|
"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": 383,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 654,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 308,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 648,
|
|
"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": 364,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 653,
|
|
"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": 325,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 318,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"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": 371,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 651,
|
|
"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": 392,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "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": 347,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
647,
|
|
650,
|
|
654,
|
|
648,
|
|
653,
|
|
652,
|
|
655,
|
|
649,
|
|
651,
|
|
646
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 336,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 639,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 567,
|
|
"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 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": 567,
|
|
"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": 810,
|
|
"name": "GenerateLinkParams",
|
|
"dereferenced": {
|
|
"id": 810,
|
|
"name": "GenerateLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 685,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 785,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 786,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 788,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 644,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 790,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 646,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 789,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 645,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 787,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 643,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
788,
|
|
790,
|
|
789,
|
|
787
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 791,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 792,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 794,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 652,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 795,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 653,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 793,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 650,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
794,
|
|
795,
|
|
793
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 796,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 797,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 799,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 659,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 800,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 660,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 657,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
799,
|
|
800,
|
|
798
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 801,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 802,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 804,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 666,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 805,
|
|
"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": 670,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 806,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 671,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 803,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 664,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
804,
|
|
805,
|
|
806,
|
|
803
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 811,
|
|
"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": 567,
|
|
"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": 567,
|
|
"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": 991,
|
|
"name": "PageParams",
|
|
"dereferenced": {
|
|
"id": 991,
|
|
"name": "PageParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1060,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 992,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 993,
|
|
"name": "page",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The page number"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1062,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 994,
|
|
"name": "perPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Number of items returned per page"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1064,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
993,
|
|
994
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1060,
|
|
"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": 616,
|
|
"name": "User"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
54,
|
|
53
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 984,
|
|
"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": 1010,
|
|
"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": 1010,
|
|
"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": 645,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 645,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 647,
|
|
"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": 357,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 650,
|
|
"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": 383,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 654,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 308,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 648,
|
|
"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": 364,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 653,
|
|
"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": 325,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 318,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"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": 371,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 651,
|
|
"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": 392,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "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": 347,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
647,
|
|
650,
|
|
654,
|
|
648,
|
|
653,
|
|
652,
|
|
655,
|
|
649,
|
|
651,
|
|
646
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 336,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 639,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 567,
|
|
"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": 164,
|
|
"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": 484,
|
|
"name": "GoTrueClientOptions",
|
|
"dereferenced": {
|
|
"id": 484,
|
|
"name": "GoTrueClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 56,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 485,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 493,
|
|
"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": 498,
|
|
"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": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 76,
|
|
"character": 21
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 500,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 501,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 502,
|
|
"name": "args",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isRest": true
|
|
},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 492,
|
|
"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": 496,
|
|
"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": 497,
|
|
"name": "flowType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 714,
|
|
"name": "AuthFlowType",
|
|
"dereferenced": {
|
|
"id": 714,
|
|
"name": "AuthFlowType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 517,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "implicit"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "pkce"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 60,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 488,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 60,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 489,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 490,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"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": 475,
|
|
"name": "LockFunc",
|
|
"dereferenced": {
|
|
"id": 475,
|
|
"name": "LockFunc",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 476,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 23
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 477,
|
|
"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": 483,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 478,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 479,
|
|
"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": 480,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to execute when the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 481,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 69
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 482,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 483,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 483,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 494,
|
|
"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": 495,
|
|
"name": "storage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 973,
|
|
"name": "SupportedStorage",
|
|
"dereferenced": {
|
|
"id": 973,
|
|
"name": "SupportedStorage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1039,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Storage",
|
|
"package": "typescript",
|
|
"name": "Storage"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "getItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "setItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "removeItem"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
],
|
|
"name": "PromisifyMethods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 491,
|
|
"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": 486,
|
|
"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": [
|
|
493,
|
|
498,
|
|
492,
|
|
496,
|
|
497,
|
|
487,
|
|
503,
|
|
494,
|
|
495,
|
|
491,
|
|
486
|
|
]
|
|
}
|
|
],
|
|
"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": 116,
|
|
"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": 966,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"dereferenced": {
|
|
"id": 966,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication administration API.",
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 970,
|
|
"name": "deleteFactor",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 971,
|
|
"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": 972,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 950,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"dereferenced": {
|
|
"id": 950,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 951,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 952,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 980,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 953,
|
|
"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": 983,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
952,
|
|
953
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 941,
|
|
"name": "AuthMFAAdminDeleteFactorResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 967,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 968,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Lists all factors associated to a user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 969,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 963,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"dereferenced": {
|
|
"id": 963,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 964,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 965,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1004,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
965
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 954,
|
|
"name": "AuthMFAAdminListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
970,
|
|
967
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1012,
|
|
"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": 645,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 645,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 647,
|
|
"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": 357,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 650,
|
|
"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": 383,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 654,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 308,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 648,
|
|
"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": 364,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 653,
|
|
"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": 325,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 318,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"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": 371,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 651,
|
|
"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": 392,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "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": 347,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
647,
|
|
650,
|
|
654,
|
|
648,
|
|
653,
|
|
652,
|
|
655,
|
|
649,
|
|
651,
|
|
646
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 336,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 639,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 567,
|
|
"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 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": 567,
|
|
"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": 810,
|
|
"name": "GenerateLinkParams",
|
|
"dereferenced": {
|
|
"id": 810,
|
|
"name": "GenerateLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 685,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 785,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 786,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 788,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 644,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 790,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 646,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 789,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 645,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 787,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 643,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
788,
|
|
790,
|
|
789,
|
|
787
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 791,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 792,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 794,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 652,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 795,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 653,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 793,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 650,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
794,
|
|
795,
|
|
793
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 796,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 797,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 799,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 659,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 800,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 660,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 657,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
799,
|
|
800,
|
|
798
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 801,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 802,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 804,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 666,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 805,
|
|
"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": 670,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 806,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 671,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 803,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 664,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
804,
|
|
805,
|
|
806,
|
|
803
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 811,
|
|
"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": 567,
|
|
"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": 567,
|
|
"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": 991,
|
|
"name": "PageParams",
|
|
"dereferenced": {
|
|
"id": 991,
|
|
"name": "PageParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1060,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 992,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 993,
|
|
"name": "page",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The page number"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1062,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 994,
|
|
"name": "perPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Number of items returned per page"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1064,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
993,
|
|
994
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1060,
|
|
"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": 616,
|
|
"name": "User"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
54,
|
|
53
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 984,
|
|
"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": 1010,
|
|
"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": 1010,
|
|
"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": 645,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 645,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 647,
|
|
"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": 357,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 650,
|
|
"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": 383,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 654,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 308,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 648,
|
|
"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": 364,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 653,
|
|
"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": 325,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 318,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"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": 371,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 651,
|
|
"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": 392,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "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": 347,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
647,
|
|
650,
|
|
654,
|
|
648,
|
|
653,
|
|
652,
|
|
655,
|
|
649,
|
|
651,
|
|
646
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 336,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 639,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 567,
|
|
"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": 120,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 921,
|
|
"name": "GoTrueMFAApi",
|
|
"dereferenced": {
|
|
"id": 921,
|
|
"name": "GoTrueMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication API."
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 925,
|
|
"name": "challenge",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 926,
|
|
"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": 927,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 845,
|
|
"name": "MFAChallengeParams",
|
|
"dereferenced": {
|
|
"id": 845,
|
|
"name": "MFAChallengeParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 762,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 846,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 847,
|
|
"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": 764,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
847
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 762,
|
|
"character": 33
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 889,
|
|
"name": "AuthMFAChallengeResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 934,
|
|
"name": "challengeAndVerify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 935,
|
|
"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": 936,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 848,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"dereferenced": {
|
|
"id": 848,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 849,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 851,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 771,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 850,
|
|
"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": 769,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
851,
|
|
850
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 42
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 852,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 922,
|
|
"name": "enroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 923,
|
|
"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": 924,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 832,
|
|
"name": "MFAEnrollParams",
|
|
"dereferenced": {
|
|
"id": 832,
|
|
"name": "MFAEnrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 833,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 834,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 739,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 836,
|
|
"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": 743,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 835,
|
|
"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": 741,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
834,
|
|
836,
|
|
835
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 865,
|
|
"name": "AuthMFAEnrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 939,
|
|
"name": "getAuthenticatorAssuranceLevel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 940,
|
|
"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": 910,
|
|
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 937,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 938,
|
|
"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": 899,
|
|
"name": "AuthMFAListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 931,
|
|
"name": "unenroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 932,
|
|
"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": 933,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 837,
|
|
"name": "MFAUnenrollParams",
|
|
"dereferenced": {
|
|
"id": 837,
|
|
"name": "MFAUnenrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 746,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 838,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 839,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 748,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
839
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 746,
|
|
"character": 32
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 880,
|
|
"name": "AuthMFAUnenrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 928,
|
|
"name": "verify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 929,
|
|
"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": 930,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 840,
|
|
"name": "MFAVerifyParams",
|
|
"dereferenced": {
|
|
"id": 840,
|
|
"name": "MFAVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 751,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 841,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 843,
|
|
"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": 756,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 844,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 759,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 842,
|
|
"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": 753,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
843,
|
|
844,
|
|
842
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 751,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 852,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
925,
|
|
934,
|
|
922,
|
|
939,
|
|
937,
|
|
931,
|
|
928
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 899,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 139,
|
|
"name": "exchangeCodeForSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 503,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 140,
|
|
"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": 141,
|
|
"name": "authCode",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 532,
|
|
"name": "AuthTokenResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 178,
|
|
"name": "getSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 849,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 179,
|
|
"name": "getSession",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 180,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 181,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 940,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 182,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 183,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 941,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 578,
|
|
"name": "Session"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
183
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 184,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 943,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
181,
|
|
184
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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/GoTrueClient.ts",
|
|
"line": 946,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 187,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 188,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 947,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
188
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 189,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 949,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
186,
|
|
189
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 190,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 191,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 952,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 192,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 193,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 953,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
193
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 194,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 955,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
191,
|
|
194
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 241,
|
|
"name": "getUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1052,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 242,
|
|
"name": "getUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Gets the current user details if there is an existing session."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 243,
|
|
"name": "jwt",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 567,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 345,
|
|
"name": "getUserIdentities",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1591,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 346,
|
|
"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": 347,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 348,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1593,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 349,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 350,
|
|
"name": "identities",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1594,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 590,
|
|
"name": "UserIdentity"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
350
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 351,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1596,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
348,
|
|
351
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 352,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 353,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1598,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 354,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1598,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
353,
|
|
354
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 126,
|
|
"name": "initialize",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 259,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 127,
|
|
"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": 974,
|
|
"name": "InitializeResult"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 355,
|
|
"name": "linkIdentity",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1615,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 356,
|
|
"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": 357,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 715,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"dereferenced": {
|
|
"id": 715,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 518,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 716,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 718,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 719,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 722,
|
|
"name": "queryParams",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object of query params"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 723,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 18
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 724,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 725,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 720,
|
|
"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": 523,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 721,
|
|
"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": 525,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 726,
|
|
"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": 529,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
722,
|
|
720,
|
|
721,
|
|
726
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 717,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 520,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 472,
|
|
"name": "Provider",
|
|
"dereferenced": {
|
|
"id": 472,
|
|
"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": [
|
|
718,
|
|
717
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 518,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 545,
|
|
"name": "OAuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 317,
|
|
"name": "onAuthStateChange",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1487,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 318,
|
|
"name": "onAuthStateChange",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Receive a notification every time an auth event happens."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 319,
|
|
"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": 320,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 321,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 322,
|
|
"name": "event",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 474,
|
|
"name": "AuthChangeEvent"
|
|
}
|
|
},
|
|
{
|
|
"id": 323,
|
|
"name": "session",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 578,
|
|
"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": 324,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 325,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1490,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 326,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 327,
|
|
"name": "subscription",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1490,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 656,
|
|
"name": "Subscription",
|
|
"dereferenced": {
|
|
"id": 656,
|
|
"name": "Subscription",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 657,
|
|
"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": 399,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 658,
|
|
"name": "callback",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 403,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 659,
|
|
"name": "callback",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 660,
|
|
"name": "event",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 474,
|
|
"name": "AuthChangeEvent",
|
|
"dereferenced": {
|
|
"id": 474,
|
|
"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": 473,
|
|
"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": 661,
|
|
"name": "session",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 578,
|
|
"name": "Session"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 662,
|
|
"name": "unsubscribe",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 407,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 663,
|
|
"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": [
|
|
657
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
658,
|
|
662
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 395,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
327
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
325
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 171,
|
|
"name": "reauthenticate",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 768,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 172,
|
|
"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": 504,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 278,
|
|
"name": "refreshSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1253,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 279,
|
|
"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": 280,
|
|
"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": 281,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 282,
|
|
"name": "refresh_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1253,
|
|
"character": 42
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
282
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 504,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 175,
|
|
"name": "resend",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 803,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 176,
|
|
"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": 177,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 758,
|
|
"name": "ResendParams",
|
|
"dereferenced": {
|
|
"id": 758,
|
|
"name": "ResendParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 598,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 759,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 761,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 601,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 762,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 763,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 765,
|
|
"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": 606,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 764,
|
|
"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": 604,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
765,
|
|
764
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 760,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 600,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 757,
|
|
"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": [
|
|
761,
|
|
762,
|
|
760
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 599,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 766,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 769,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 612,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 770,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 771,
|
|
"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": 614,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
771
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 612,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 768,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 611,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 767,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 610,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 756,
|
|
"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": [
|
|
769,
|
|
768,
|
|
767
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 609,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 517,
|
|
"name": "AuthOtpResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 331,
|
|
"name": "resetPasswordForEmail",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1543,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 332,
|
|
"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": 333,
|
|
"name": "email",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The email address of the user."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 334,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 335,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 337,
|
|
"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": 1547,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 336,
|
|
"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": 1546,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
337,
|
|
336
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 338,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 339,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1551,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 340,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 341,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1552,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
339,
|
|
341
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 1554,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 344,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1554,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
343,
|
|
344
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 266,
|
|
"name": "setSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1178,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 267,
|
|
"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": 268,
|
|
"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": 269,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 270,
|
|
"name": "access_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1179,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 271,
|
|
"name": "refresh_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1180,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
270,
|
|
271
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 504,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 159,
|
|
"name": "signInWithIdToken",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 554,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 160,
|
|
"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": 161,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 727,
|
|
"name": "SignInWithIdTokenCredentials",
|
|
"dereferenced": {
|
|
"id": 727,
|
|
"name": "SignInWithIdTokenCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 533,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 728,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 731,
|
|
"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": 539,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"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": 541,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 542,
|
|
"character": 2
|
|
}
|
|
],
|
|
"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": 544,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
735
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 542,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 729,
|
|
"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": 535,
|
|
"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": 730,
|
|
"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": 537,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
731,
|
|
732,
|
|
733,
|
|
729,
|
|
730
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 533,
|
|
"character": 43
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 532,
|
|
"name": "AuthTokenResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 136,
|
|
"name": "signInWithOAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 489,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 137,
|
|
"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": 138,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 715,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"dereferenced": {
|
|
"id": 715,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 518,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 716,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 718,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 719,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 722,
|
|
"name": "queryParams",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object of query params"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 723,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 18
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 724,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 725,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 720,
|
|
"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": 523,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 721,
|
|
"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": 525,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 726,
|
|
"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": 529,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
722,
|
|
720,
|
|
721,
|
|
726
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 717,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 520,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 472,
|
|
"name": "Provider",
|
|
"dereferenced": {
|
|
"id": 472,
|
|
"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": [
|
|
718,
|
|
717
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 518,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 545,
|
|
"name": "OAuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 162,
|
|
"name": "signInWithOtp",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 611,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 163,
|
|
"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": 164,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "SignInWithPasswordlessCredentials",
|
|
"dereferenced": {
|
|
"id": 697,
|
|
"name": "SignInWithPasswordlessCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 479,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 698,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 699,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 482,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 700,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 483,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 701,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 705,
|
|
"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": 495,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 704,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 493,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 702,
|
|
"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": 485,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 703,
|
|
"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": 487,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
705,
|
|
704,
|
|
702,
|
|
703
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 483,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
699,
|
|
700
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 480,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 706,
|
|
"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": 501,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 709,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 712,
|
|
"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": 511,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 713,
|
|
"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": 513,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 711,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 509,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 710,
|
|
"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": 503,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
712,
|
|
713,
|
|
711,
|
|
710
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 501,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 707,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 500,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
708,
|
|
707
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 498,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 517,
|
|
"name": "AuthOtpResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 133,
|
|
"name": "signInWithPassword",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 433,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 134,
|
|
"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": 135,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 683,
|
|
"name": "SignInWithPasswordCredentials",
|
|
"dereferenced": {
|
|
"id": 683,
|
|
"name": "SignInWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 451,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 684,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 685,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 454,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 687,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 457,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 688,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 689,
|
|
"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": 459,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
689
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 457,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 686,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 456,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
685,
|
|
687,
|
|
686
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 452,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 690,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 693,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 467,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 694,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 696,
|
|
"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": 475,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 695,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 473,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
696,
|
|
695
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 467,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 692,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 466,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 691,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 464,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
693,
|
|
692,
|
|
691
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 462,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 532,
|
|
"name": "AuthTokenResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 168,
|
|
"name": "signInWithSSO",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 729,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 169,
|
|
"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": 170,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 772,
|
|
"name": "SignInWithSSO",
|
|
"dereferenced": {
|
|
"id": 772,
|
|
"name": "SignInWithSSO",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 618,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 773,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 775,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 623,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 776,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 778,
|
|
"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": 627,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 777,
|
|
"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": 625,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
778,
|
|
777
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 623,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 774,
|
|
"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": 621,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
775,
|
|
774
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 619,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 779,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 780,
|
|
"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": 632,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 781,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 634,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 782,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 784,
|
|
"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": 638,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 783,
|
|
"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": 636,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
784,
|
|
783
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 634,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
780,
|
|
781
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 630,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 558,
|
|
"name": "SSOResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 307,
|
|
"name": "signOut",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1447,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 308,
|
|
"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": 309,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 995,
|
|
"name": "SignOut",
|
|
"dereferenced": {
|
|
"id": 995,
|
|
"name": "SignOut",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1067,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 996,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 997,
|
|
"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": 1078,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "global"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "local"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "others"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
997
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1067,
|
|
"character": 22
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 310,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 311,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1447,
|
|
"character": 67
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
311
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 130,
|
|
"name": "signUp",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 354,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 131,
|
|
"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": 132,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 666,
|
|
"name": "SignUpWithPasswordCredentials",
|
|
"dereferenced": {
|
|
"id": 666,
|
|
"name": "SignUpWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 414,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 667,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 668,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 417,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 670,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 420,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 671,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 674,
|
|
"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": 430,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 673,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 428,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 672,
|
|
"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": 422,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
674,
|
|
673,
|
|
672
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 420,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 669,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 419,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
668,
|
|
670,
|
|
669
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 415,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 675,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 678,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 438,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 679,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 681,
|
|
"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": 446,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 682,
|
|
"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": 448,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 680,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 444,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
681,
|
|
682,
|
|
680
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 438,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 677,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 437,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 676,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 435,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
678,
|
|
677,
|
|
676
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 433,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 504,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "startAutoRefresh",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2023,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "stopAutoRefresh",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2036,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 416,
|
|
"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": 358,
|
|
"name": "unlinkIdentity",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1651,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 359,
|
|
"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": 360,
|
|
"name": "identity",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 590,
|
|
"name": "UserIdentity",
|
|
"dereferenced": {
|
|
"id": 590,
|
|
"name": "UserIdentity",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 599,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 238,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 591,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 231,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 593,
|
|
"name": "identity_data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 233,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 594,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 595,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 596,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 597,
|
|
"name": "identity_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 236,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 600,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 239,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 598,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 237,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 601,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 240,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 592,
|
|
"name": "user_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 232,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
599,
|
|
591,
|
|
593,
|
|
597,
|
|
600,
|
|
598,
|
|
601,
|
|
592
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 230,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 361,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 362,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1653,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 363,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 364,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1654,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
362,
|
|
364
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 1656,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 367,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1656,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
366,
|
|
367
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 247,
|
|
"name": "updateUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1098,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 248,
|
|
"name": "updateUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updates user data for a logged in user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 249,
|
|
"name": "attributes",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 639,
|
|
"name": "UserAttributes",
|
|
"dereferenced": {
|
|
"id": 639,
|
|
"name": "UserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 644,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 333,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 640,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 308,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 643,
|
|
"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": 325,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 642,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 318,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 641,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
644,
|
|
640,
|
|
643,
|
|
642,
|
|
641
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 304,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 250,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 251,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 252,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1101,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
252
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 567,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 165,
|
|
"name": "verifyOtp",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 666,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 166,
|
|
"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": 167,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 736,
|
|
"name": "VerifyOtpParams",
|
|
"dereferenced": {
|
|
"id": 736,
|
|
"name": "VerifyOtpParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 548,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 737,
|
|
"name": "VerifyMobileOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 741,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 556,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 742,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 744,
|
|
"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": 565,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 743,
|
|
"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": 558,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
744,
|
|
743
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 551,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"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": 553,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 555,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 756,
|
|
"name": "MobileOtpType",
|
|
"dereferenced": {
|
|
"id": 756,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 595,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
741,
|
|
738,
|
|
739,
|
|
740
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 549,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 745,
|
|
"name": "VerifyEmailOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 746,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 570,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 749,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 575,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 750,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 752,
|
|
"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": 583,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 751,
|
|
"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": 577,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
752,
|
|
751
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 747,
|
|
"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": 572,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 748,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 574,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"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": [
|
|
746,
|
|
749,
|
|
747,
|
|
748
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 568,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 753,
|
|
"name": "VerifyTokenHashParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 754,
|
|
"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": 589,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 755,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 592,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"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": [
|
|
754,
|
|
755
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 587,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 504,
|
|
"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": [
|
|
139,
|
|
178,
|
|
241,
|
|
345,
|
|
126,
|
|
355,
|
|
317,
|
|
171,
|
|
278,
|
|
175,
|
|
331,
|
|
266,
|
|
159,
|
|
136,
|
|
162,
|
|
133,
|
|
168,
|
|
307,
|
|
130,
|
|
413,
|
|
415,
|
|
358,
|
|
247,
|
|
165
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 107,
|
|
"character": 21
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 464,
|
|
"name": "NavigatorLockAcquireTimeoutError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 465,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 466,
|
|
"name": "new NavigatorLockAcquireTimeoutError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 467,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 464,
|
|
"name": "NavigatorLockAcquireTimeoutError"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 468,
|
|
"name": "isAcquireTimeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isReadonly": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 19,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": true
|
|
},
|
|
"defaultValue": "true",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError.isAcquireTimeout"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
465
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
468
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 26,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 587,
|
|
"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": 588,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Authentication method name."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 221,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 589,
|
|
"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": 227,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
588,
|
|
589
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 219,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 645,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 647,
|
|
"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": 357,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 650,
|
|
"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": 383,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 654,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 308,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 648,
|
|
"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": 364,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 653,
|
|
"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": 325,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 318,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"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": 371,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 651,
|
|
"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": 392,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "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": 347,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
647,
|
|
650,
|
|
654,
|
|
648,
|
|
653,
|
|
652,
|
|
655,
|
|
649,
|
|
651,
|
|
646
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 336,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 639,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 602,
|
|
"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": 607,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 266,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 605,
|
|
"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": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 604,
|
|
"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": 255,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 603,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 252,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 606,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Factor's status."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 264,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "verified"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "unverified"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 608,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 267,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
607,
|
|
605,
|
|
604,
|
|
603,
|
|
606,
|
|
608
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 250,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 808,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 680,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 809,
|
|
"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": 682,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
808,
|
|
809
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 674,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 966,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication administration API.",
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 970,
|
|
"name": "deleteFactor",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 971,
|
|
"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": 972,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 950,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"dereferenced": {
|
|
"id": 950,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 951,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 952,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 980,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 953,
|
|
"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": 983,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
952,
|
|
953
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 941,
|
|
"name": "AuthMFAAdminDeleteFactorResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 967,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 968,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Lists all factors associated to a user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 969,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 963,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"dereferenced": {
|
|
"id": 963,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 964,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 965,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1004,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
965
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 954,
|
|
"name": "AuthMFAAdminListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
970,
|
|
967
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1012,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 921,
|
|
"name": "GoTrueMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication API."
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 925,
|
|
"name": "challenge",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 926,
|
|
"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": 927,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 845,
|
|
"name": "MFAChallengeParams",
|
|
"dereferenced": {
|
|
"id": 845,
|
|
"name": "MFAChallengeParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 762,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 846,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 847,
|
|
"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": 764,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
847
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 762,
|
|
"character": 33
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 889,
|
|
"name": "AuthMFAChallengeResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 934,
|
|
"name": "challengeAndVerify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 935,
|
|
"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": 936,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 848,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"dereferenced": {
|
|
"id": 848,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 849,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 851,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 771,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 850,
|
|
"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": 769,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
851,
|
|
850
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 42
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 852,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 922,
|
|
"name": "enroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 923,
|
|
"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": 924,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 832,
|
|
"name": "MFAEnrollParams",
|
|
"dereferenced": {
|
|
"id": 832,
|
|
"name": "MFAEnrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 833,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 834,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 739,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 836,
|
|
"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": 743,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 835,
|
|
"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": 741,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
834,
|
|
836,
|
|
835
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 865,
|
|
"name": "AuthMFAEnrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 939,
|
|
"name": "getAuthenticatorAssuranceLevel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 940,
|
|
"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": 910,
|
|
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 937,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 938,
|
|
"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": 899,
|
|
"name": "AuthMFAListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 931,
|
|
"name": "unenroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 932,
|
|
"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": 933,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 837,
|
|
"name": "MFAUnenrollParams",
|
|
"dereferenced": {
|
|
"id": 837,
|
|
"name": "MFAUnenrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 746,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 838,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 839,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 748,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
839
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 746,
|
|
"character": 32
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 880,
|
|
"name": "AuthMFAUnenrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 928,
|
|
"name": "verify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 929,
|
|
"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": 930,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 840,
|
|
"name": "MFAVerifyParams",
|
|
"dereferenced": {
|
|
"id": 840,
|
|
"name": "MFAVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 751,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 841,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 843,
|
|
"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": 756,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 844,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 759,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 842,
|
|
"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": 753,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
843,
|
|
844,
|
|
842
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 751,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 852,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
925,
|
|
934,
|
|
922,
|
|
939,
|
|
937,
|
|
931,
|
|
928
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 899,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 578,
|
|
"name": "Session",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 581,
|
|
"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": 194,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 584,
|
|
"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": 206,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 583,
|
|
"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": 202,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 580,
|
|
"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": 190,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 579,
|
|
"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": 185,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 582,
|
|
"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": 198,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 585,
|
|
"name": "token_type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 207,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 586,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 208,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 616,
|
|
"name": "User",
|
|
"dereferenced": {
|
|
"id": 616,
|
|
"name": "User",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 627,
|
|
"name": "action_link",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 290,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 618,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 281,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 609,
|
|
"name": "UserAppMetadata",
|
|
"dereferenced": {
|
|
"id": 609,
|
|
"name": "UserAppMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 610,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 271,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
610
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 270,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 611,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 612,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"name": "aud",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 283,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 621,
|
|
"name": "confirmation_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 284,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 631,
|
|
"name": "confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 294,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 630,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 293,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 628,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 291,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 623,
|
|
"name": "email_change_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 286,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 632,
|
|
"name": "email_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 638,
|
|
"name": "factors",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 301,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 602,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 617,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 280,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 637,
|
|
"name": "identities",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 300,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 590,
|
|
"name": "UserIdentity"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 626,
|
|
"name": "invited_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 289,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 634,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 297,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 624,
|
|
"name": "new_email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 287,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 625,
|
|
"name": "new_phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 288,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 629,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 292,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 633,
|
|
"name": "phone_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 296,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "recovery_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 285,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 635,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 298,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 636,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 299,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 619,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 282,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "UserMetadata",
|
|
"dereferenced": {
|
|
"id": 613,
|
|
"name": "UserMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 275,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 614,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 615,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
627,
|
|
618,
|
|
620,
|
|
621,
|
|
631,
|
|
630,
|
|
628,
|
|
623,
|
|
632,
|
|
638,
|
|
617,
|
|
637,
|
|
626,
|
|
634,
|
|
624,
|
|
625,
|
|
629,
|
|
633,
|
|
622,
|
|
635,
|
|
636,
|
|
619
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 279,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
581,
|
|
584,
|
|
583,
|
|
580,
|
|
579,
|
|
582,
|
|
585,
|
|
586
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 181,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 656,
|
|
"name": "Subscription",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 657,
|
|
"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": 399,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 658,
|
|
"name": "callback",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 403,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 659,
|
|
"name": "callback",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 660,
|
|
"name": "event",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 474,
|
|
"name": "AuthChangeEvent",
|
|
"dereferenced": {
|
|
"id": 474,
|
|
"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": 473,
|
|
"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": 661,
|
|
"name": "session",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 578,
|
|
"name": "Session"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 662,
|
|
"name": "unsubscribe",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 407,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 663,
|
|
"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": [
|
|
657
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
658,
|
|
662
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 395,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 664,
|
|
"name": "UpdatableFactorAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 665,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 411,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
665
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 410,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 616,
|
|
"name": "User",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 627,
|
|
"name": "action_link",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 290,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 618,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 281,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 609,
|
|
"name": "UserAppMetadata",
|
|
"dereferenced": {
|
|
"id": 609,
|
|
"name": "UserAppMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 610,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 271,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
610
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 270,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 611,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 612,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"name": "aud",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 283,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 621,
|
|
"name": "confirmation_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 284,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 631,
|
|
"name": "confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 294,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 630,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 293,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 628,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 291,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 623,
|
|
"name": "email_change_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 286,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 632,
|
|
"name": "email_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 638,
|
|
"name": "factors",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 301,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 602,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 617,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 280,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 637,
|
|
"name": "identities",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 300,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 590,
|
|
"name": "UserIdentity"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 626,
|
|
"name": "invited_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 289,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 634,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 297,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 624,
|
|
"name": "new_email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 287,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 625,
|
|
"name": "new_phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 288,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 629,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 292,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 633,
|
|
"name": "phone_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 296,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "recovery_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 285,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 635,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 298,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 636,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 299,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 619,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 282,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "UserMetadata",
|
|
"dereferenced": {
|
|
"id": 613,
|
|
"name": "UserMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 275,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 614,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 615,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
627,
|
|
618,
|
|
620,
|
|
621,
|
|
631,
|
|
630,
|
|
628,
|
|
623,
|
|
632,
|
|
638,
|
|
617,
|
|
637,
|
|
626,
|
|
634,
|
|
624,
|
|
625,
|
|
629,
|
|
633,
|
|
622,
|
|
635,
|
|
636,
|
|
619
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 279,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 609,
|
|
"name": "UserAppMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 610,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 271,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
610
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 270,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 611,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 612,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 639,
|
|
"name": "UserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 644,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 333,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 640,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 308,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 643,
|
|
"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": 325,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 642,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 318,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 641,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
644,
|
|
640,
|
|
643,
|
|
642,
|
|
641
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 304,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 590,
|
|
"name": "UserIdentity",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 599,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 238,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 591,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 231,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 593,
|
|
"name": "identity_data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 233,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 594,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 595,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 596,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 597,
|
|
"name": "identity_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 236,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 600,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 239,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 598,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 237,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 601,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 240,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 592,
|
|
"name": "user_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 232,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
599,
|
|
591,
|
|
593,
|
|
597,
|
|
600,
|
|
598,
|
|
601,
|
|
592
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 230,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 613,
|
|
"name": "UserMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 275,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 614,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 615,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 745,
|
|
"name": "VerifyEmailOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 746,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 570,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 749,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 575,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 750,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 752,
|
|
"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": 583,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 751,
|
|
"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": 577,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
752,
|
|
751
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 747,
|
|
"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": 572,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 748,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 574,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"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": [
|
|
746,
|
|
749,
|
|
747,
|
|
748
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 568,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 737,
|
|
"name": "VerifyMobileOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 741,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 556,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 742,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 744,
|
|
"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": 565,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 743,
|
|
"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": 558,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
744,
|
|
743
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 551,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"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": 553,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 555,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 756,
|
|
"name": "MobileOtpType",
|
|
"dereferenced": {
|
|
"id": 756,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 595,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
741,
|
|
738,
|
|
739,
|
|
740
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 549,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 753,
|
|
"name": "VerifyTokenHashParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 754,
|
|
"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": 589,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 755,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 592,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"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": [
|
|
754,
|
|
755
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 587,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 474,
|
|
"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": 473,
|
|
"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": 473,
|
|
"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": 714,
|
|
"name": "AuthFlowType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 517,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "implicit"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "pkce"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 950,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 951,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 952,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 980,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 953,
|
|
"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": 983,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
952,
|
|
953
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 978,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 941,
|
|
"name": "AuthMFAAdminDeleteFactorResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 965,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"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": 967,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 944,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 945,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was successfully deleted."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 969,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
945
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 967,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 946,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 971,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
943,
|
|
946
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 966,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 947,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 948,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 973,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 949,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 973,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
948,
|
|
949
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 973,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 963,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 964,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 965,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1004,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
965
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1002,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 954,
|
|
"name": "AuthMFAAdminListFactorsResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 989,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 955,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 956,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 991,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 957,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 958,
|
|
"name": "factors",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "All factors attached to the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 993,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 602,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
958
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 991,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 959,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 995,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
956,
|
|
959
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 990,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 960,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 961,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 997,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 962,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 997,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
961,
|
|
962
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 997,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 889,
|
|
"name": "AuthMFAChallengeResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 842,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 890,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 891,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 844,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 892,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 894,
|
|
"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": 849,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 893,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the newly created challenge."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 846,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
894,
|
|
893
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 844,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 895,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 851,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
891,
|
|
895
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 843,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 896,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 897,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 853,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 898,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 853,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
897,
|
|
898
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 853,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 865,
|
|
"name": "AuthMFAEnrollResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 799,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 866,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 867,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 801,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 868,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 869,
|
|
"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": 803,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 871,
|
|
"name": "totp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "TOTP enrollment information."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 809,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 872,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 873,
|
|
"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": 813,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 874,
|
|
"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": 818,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 875,
|
|
"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": 822,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
873,
|
|
874,
|
|
875
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 809,
|
|
"character": 14
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 870,
|
|
"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": 806,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
869,
|
|
871,
|
|
870
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 801,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 876,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 825,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
867,
|
|
876
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 800,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 877,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 878,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 828,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 879,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 829,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
878,
|
|
879
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 827,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 910,
|
|
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 870,
|
|
"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": 872,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 913,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 916,
|
|
"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": 889,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 587,
|
|
"name": "AMREntry"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 914,
|
|
"name": "currentLevel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Current AAL level of the session."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 874,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 909,
|
|
"name": "AuthenticatorAssuranceLevels"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 915,
|
|
"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": 882,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 909,
|
|
"name": "AuthenticatorAssuranceLevels"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
916,
|
|
914,
|
|
915
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 872,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 917,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 891,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
912,
|
|
917
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 871,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 918,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 919,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 893,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 920,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 893,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
919,
|
|
920
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 893,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 899,
|
|
"name": "AuthMFAListFactorsResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 855,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 900,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 901,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 857,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 902,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 903,
|
|
"name": "all",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "All available factors (verified and unverified)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 859,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 602,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 904,
|
|
"name": "totp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Only verified TOTP factors. (A subset of `all`.)"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 862,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 602,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
903,
|
|
904
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 857,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 905,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 864,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
901,
|
|
905
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 856,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 906,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 907,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 866,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 908,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 866,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
907,
|
|
908
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 866,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 880,
|
|
"name": "AuthMFAUnenrollResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 832,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 881,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 882,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 834,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 883,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 884,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was successfully unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 836,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
884
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 834,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 885,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 838,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
882,
|
|
885
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 833,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 886,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 887,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 840,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 888,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 840,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
887,
|
|
888
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 840,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 852,
|
|
"name": "AuthMFAVerifyResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 774,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 853,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 854,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 776,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 855,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 856,
|
|
"name": "access_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "New access token (JWT) after successful verification."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 778,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 858,
|
|
"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": 784,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 859,
|
|
"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": 787,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 857,
|
|
"name": "token_type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Type of token, typically `Bearer`."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 781,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 860,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updated user profile."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 790,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 616,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
856,
|
|
858,
|
|
859,
|
|
857,
|
|
860
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 776,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 861,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 792,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
854,
|
|
861
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 775,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 862,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 863,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 795,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 864,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 796,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
863,
|
|
864
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 794,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 517,
|
|
"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": 106,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 518,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 519,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 108,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 520,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 523,
|
|
"name": "messageId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 108,
|
|
"character": 41
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 522,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 108,
|
|
"character": 26
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 521,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 108,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
523,
|
|
522,
|
|
521
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 108,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 524,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 109,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
519,
|
|
524
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 107,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 525,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 526,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 112,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 527,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 530,
|
|
"name": "messageId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 112,
|
|
"character": 41
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 529,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 112,
|
|
"character": 26
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 528,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 112,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
530,
|
|
529,
|
|
528
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 112,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 531,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 113,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
526,
|
|
531
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 111,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"name": "AuthResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 85,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 505,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 506,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 87,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 507,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 509,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 89,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 578,
|
|
"name": "Session"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 508,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 88,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 616,
|
|
"name": "User"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
509,
|
|
508
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 87,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 91,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
506,
|
|
510
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 86,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 511,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 512,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 94,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 513,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 515,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 96,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 514,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 95,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
515,
|
|
514
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 94,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 516,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 98,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
512,
|
|
516
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 93,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 532,
|
|
"name": "AuthTokenResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 116,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 533,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 534,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 118,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 535,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 537,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 120,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 578,
|
|
"name": "Session"
|
|
}
|
|
},
|
|
{
|
|
"id": 536,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 119,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 616,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
537,
|
|
536
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 118,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 538,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 122,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
534,
|
|
538
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 117,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 539,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 540,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 125,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 541,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 543,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 127,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 542,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 126,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
543,
|
|
542
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 125,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 544,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 129,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
540,
|
|
544
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 124,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 909,
|
|
"name": "AuthenticatorAssuranceLevels",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 868,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "aal1"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "aal2"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 977,
|
|
"name": "CallRefreshTokenResult",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1043,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 978,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 980,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1046,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 979,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1045,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 578,
|
|
"name": "Session"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
980,
|
|
979
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1044,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 981,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 983,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1050,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
},
|
|
{
|
|
"id": 982,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1049,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
983,
|
|
982
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1048,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"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": 801,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 802,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 804,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 666,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 805,
|
|
"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": 670,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 806,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 671,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 803,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 664,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
804,
|
|
805,
|
|
806,
|
|
803
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 791,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 792,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 794,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 652,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 795,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 653,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 793,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 650,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
794,
|
|
795,
|
|
793
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 810,
|
|
"name": "GenerateLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 685,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 785,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 786,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 788,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 644,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 790,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 646,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 789,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 645,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 787,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 643,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
788,
|
|
790,
|
|
789,
|
|
787
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 791,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 792,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 794,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 652,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 795,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 653,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 793,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 650,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
794,
|
|
795,
|
|
793
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 649,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 796,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 797,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 799,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 659,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 800,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 660,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 657,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
799,
|
|
800,
|
|
798
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 801,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 802,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 804,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 666,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 805,
|
|
"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": 670,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 806,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 671,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 803,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 664,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
804,
|
|
805,
|
|
806,
|
|
803
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 824,
|
|
"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": 708,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 825,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 826,
|
|
"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": 713,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 827,
|
|
"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": 718,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 828,
|
|
"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": 722,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 829,
|
|
"name": "redirect_to",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The URL appended to the action link."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 724,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 830,
|
|
"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": 726,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 831,
|
|
"name": "GenerateLinkType",
|
|
"dereferenced": {
|
|
"id": 831,
|
|
"name": "GenerateLinkType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 729,
|
|
"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": [
|
|
826,
|
|
827,
|
|
828,
|
|
829,
|
|
830
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 708,
|
|
"character": 37
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 811,
|
|
"name": "GenerateLinkResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 691,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 812,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 813,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 693,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 814,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 815,
|
|
"name": "properties",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 694,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 824,
|
|
"name": "GenerateLinkProperties"
|
|
}
|
|
},
|
|
{
|
|
"id": 816,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 695,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 616,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
815,
|
|
816
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 693,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 817,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 697,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
813,
|
|
817
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 692,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 818,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 819,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 700,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 820,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 821,
|
|
"name": "properties",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 701,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 822,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 702,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
821,
|
|
822
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 700,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 823,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 704,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
819,
|
|
823
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 699,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 831,
|
|
"name": "GenerateLinkType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 729,
|
|
"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": 796,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 797,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 799,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 659,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 800,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 660,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 657,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
799,
|
|
800,
|
|
798
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 785,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 786,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 788,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 644,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 790,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 646,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 807,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 789,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 645,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 787,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 643,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
788,
|
|
790,
|
|
789,
|
|
787
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 484,
|
|
"name": "GoTrueClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 56,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 485,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 493,
|
|
"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": 498,
|
|
"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": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 76,
|
|
"character": 21
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 500,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 501,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 502,
|
|
"name": "args",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isRest": true
|
|
},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 492,
|
|
"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": 496,
|
|
"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": 497,
|
|
"name": "flowType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 714,
|
|
"name": "AuthFlowType",
|
|
"dereferenced": {
|
|
"id": 714,
|
|
"name": "AuthFlowType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 517,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "implicit"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "pkce"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 60,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 488,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 60,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 489,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 490,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"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": 475,
|
|
"name": "LockFunc",
|
|
"dereferenced": {
|
|
"id": 475,
|
|
"name": "LockFunc",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 476,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 23
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 477,
|
|
"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": 483,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 478,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 479,
|
|
"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": 480,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to execute when the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 481,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 69
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 482,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 483,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 483,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 494,
|
|
"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": 495,
|
|
"name": "storage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 973,
|
|
"name": "SupportedStorage",
|
|
"dereferenced": {
|
|
"id": 973,
|
|
"name": "SupportedStorage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1039,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Storage",
|
|
"package": "typescript",
|
|
"name": "Storage"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "getItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "setItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "removeItem"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
],
|
|
"name": "PromisifyMethods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 491,
|
|
"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": 486,
|
|
"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": [
|
|
493,
|
|
498,
|
|
492,
|
|
496,
|
|
497,
|
|
487,
|
|
503,
|
|
494,
|
|
495,
|
|
491,
|
|
486
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 56,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 974,
|
|
"name": "InitializeResult",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1041,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 975,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 976,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1041,
|
|
"character": 33
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
976
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1041,
|
|
"character": 31
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 475,
|
|
"name": "LockFunc",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 476,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 23
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 477,
|
|
"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": 483,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 478,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 479,
|
|
"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": 480,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to execute when the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 481,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 54,
|
|
"character": 69
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 482,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 483,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 483,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 848,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 849,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 851,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 771,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 850,
|
|
"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": 769,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
851,
|
|
850
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 42
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 845,
|
|
"name": "MFAChallengeParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 762,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 846,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 847,
|
|
"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": 764,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
847
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 762,
|
|
"character": 33
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 832,
|
|
"name": "MFAEnrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 833,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 834,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 739,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 836,
|
|
"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": 743,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 835,
|
|
"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": 741,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
834,
|
|
836,
|
|
835
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 837,
|
|
"name": "MFAUnenrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 746,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 838,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 839,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 748,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
839
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 746,
|
|
"character": 32
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 840,
|
|
"name": "MFAVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 751,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 841,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 843,
|
|
"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": 756,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 844,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 759,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 842,
|
|
"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": 753,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
843,
|
|
844,
|
|
842
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 751,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 756,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 595,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 545,
|
|
"name": "OAuthResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 132,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 546,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 547,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 134,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 548,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 549,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 135,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 472,
|
|
"name": "Provider"
|
|
}
|
|
},
|
|
{
|
|
"id": 550,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 136,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
549,
|
|
550
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 134,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 551,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 138,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
547,
|
|
551
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 133,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 552,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 553,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 554,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 555,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 142,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 472,
|
|
"name": "Provider"
|
|
}
|
|
},
|
|
{
|
|
"id": 556,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 143,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
555,
|
|
556
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 557,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 145,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
553,
|
|
557
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 140,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 991,
|
|
"name": "PageParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1060,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 992,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 993,
|
|
"name": "page",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The page number"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1062,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 994,
|
|
"name": "perPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Number of items returned per page"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1064,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
993,
|
|
994
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1060,
|
|
"character": 25
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 984,
|
|
"name": "Pagination",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1053,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 985,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 987,
|
|
"name": "lastPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1056,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 986,
|
|
"name": "nextPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1055,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 988,
|
|
"name": "total",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1057,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
987,
|
|
986,
|
|
988
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1053,
|
|
"character": 25
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 989,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 990,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 472,
|
|
"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": 758,
|
|
"name": "ResendParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 598,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 759,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 761,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 601,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 762,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 763,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 765,
|
|
"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": 606,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 764,
|
|
"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": 604,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
765,
|
|
764
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 760,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 600,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 757,
|
|
"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": [
|
|
761,
|
|
762,
|
|
760
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 599,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 766,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 769,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 612,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 770,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 771,
|
|
"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": 614,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
771
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 612,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 768,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 611,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 767,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 610,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 756,
|
|
"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": [
|
|
769,
|
|
768,
|
|
767
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 609,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 558,
|
|
"name": "SSOResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 148,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 559,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 560,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 150,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 561,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 562,
|
|
"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": 158,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
562
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 150,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 563,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 160,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
560,
|
|
563
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 149,
|
|
"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": 163,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 566,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 164,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
565,
|
|
566
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 162,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 727,
|
|
"name": "SignInWithIdTokenCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 533,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 728,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 731,
|
|
"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": 539,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"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": 541,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 542,
|
|
"character": 2
|
|
}
|
|
],
|
|
"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": 544,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
735
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 542,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 729,
|
|
"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": 535,
|
|
"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": 730,
|
|
"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": 537,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
731,
|
|
732,
|
|
733,
|
|
729,
|
|
730
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 533,
|
|
"character": 43
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 715,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 518,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 716,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 718,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 719,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 722,
|
|
"name": "queryParams",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object of query params"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 723,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 18
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 724,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 725,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 720,
|
|
"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": 523,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 721,
|
|
"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": 525,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 726,
|
|
"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": 529,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
722,
|
|
720,
|
|
721,
|
|
726
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 717,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 520,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 472,
|
|
"name": "Provider",
|
|
"dereferenced": {
|
|
"id": 472,
|
|
"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": [
|
|
718,
|
|
717
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 518,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 683,
|
|
"name": "SignInWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 451,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 684,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 685,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 454,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 687,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 457,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 688,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 689,
|
|
"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": 459,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
689
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 457,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 686,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 456,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
685,
|
|
687,
|
|
686
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 452,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 690,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 693,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 467,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 694,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 696,
|
|
"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": 475,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 695,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 473,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
696,
|
|
695
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 467,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 692,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 466,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 691,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 464,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
693,
|
|
692,
|
|
691
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 462,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 697,
|
|
"name": "SignInWithPasswordlessCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 479,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 698,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 699,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 482,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 700,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 483,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 701,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 705,
|
|
"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": 495,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 704,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 493,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 702,
|
|
"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": 485,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 703,
|
|
"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": 487,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
705,
|
|
704,
|
|
702,
|
|
703
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 483,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
699,
|
|
700
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 480,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 706,
|
|
"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": 501,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 709,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 712,
|
|
"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": 511,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 713,
|
|
"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": 513,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 711,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 509,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 710,
|
|
"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": 503,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
712,
|
|
713,
|
|
711,
|
|
710
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 501,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 707,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 500,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
708,
|
|
707
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 498,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 772,
|
|
"name": "SignInWithSSO",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 618,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 773,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 775,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 623,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 776,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 778,
|
|
"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": 627,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 777,
|
|
"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": 625,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
778,
|
|
777
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 623,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 774,
|
|
"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": 621,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
775,
|
|
774
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 619,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 779,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 780,
|
|
"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": 632,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 781,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 634,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 782,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 784,
|
|
"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": 638,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 783,
|
|
"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": 636,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
784,
|
|
783
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 634,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
780,
|
|
781
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 630,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 995,
|
|
"name": "SignOut",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1067,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 996,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 997,
|
|
"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": 1078,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "global"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "local"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "others"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
997
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1067,
|
|
"character": 22
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 666,
|
|
"name": "SignUpWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 414,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 667,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 668,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 417,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 670,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 420,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 671,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 674,
|
|
"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": 430,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 673,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 428,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 672,
|
|
"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": 422,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
674,
|
|
673,
|
|
672
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 420,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 669,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 419,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
668,
|
|
670,
|
|
669
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 415,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 675,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 678,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 438,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 679,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 681,
|
|
"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": 446,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 682,
|
|
"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": 448,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 680,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 444,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
681,
|
|
682,
|
|
680
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 438,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 677,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 437,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 676,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 435,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
678,
|
|
677,
|
|
676
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 433,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 973,
|
|
"name": "SupportedStorage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1039,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Storage",
|
|
"package": "typescript",
|
|
"name": "Storage"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "getItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "setItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "removeItem"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
],
|
|
"name": "PromisifyMethods"
|
|
}
|
|
},
|
|
{
|
|
"id": 567,
|
|
"name": "UserResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 167,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 568,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 569,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 169,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 570,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 571,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 170,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 616,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
571
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 169,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 572,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 172,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
569,
|
|
572
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 168,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 573,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 574,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 175,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 575,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 576,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 176,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
576
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 175,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 577,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 178,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
574,
|
|
577
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 174,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 736,
|
|
"name": "VerifyOtpParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 548,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 737,
|
|
"name": "VerifyMobileOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 741,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 556,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 742,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 744,
|
|
"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": 565,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 743,
|
|
"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": 558,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
744,
|
|
743
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 551,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"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": 553,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 555,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 756,
|
|
"name": "MobileOtpType",
|
|
"dereferenced": {
|
|
"id": 756,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 595,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
741,
|
|
738,
|
|
739,
|
|
740
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 549,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 745,
|
|
"name": "VerifyEmailOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 746,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 570,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 749,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 575,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 750,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 752,
|
|
"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": 583,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 751,
|
|
"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": 577,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
752,
|
|
751
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 747,
|
|
"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": 572,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 748,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 574,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"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": [
|
|
746,
|
|
749,
|
|
747,
|
|
748
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 568,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 753,
|
|
"name": "VerifyTokenHashParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 754,
|
|
"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": 589,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 755,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 592,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 757,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"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": [
|
|
754,
|
|
755
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 587,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 469,
|
|
"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": 470,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 471,
|
|
"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": [
|
|
471
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1001,
|
|
"name": "isAuthApiError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 34,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1002,
|
|
"name": "isAuthApiError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1003,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1017,
|
|
"name": "AuthApiError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 998,
|
|
"name": "isAuthError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 12,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 999,
|
|
"name": "isAuthError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1000,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1010,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1004,
|
|
"name": "isAuthRetryableFetchError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 124,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1005,
|
|
"name": "isAuthRetryableFetchError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1006,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1140,
|
|
"name": "AuthRetryableFetchError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1007,
|
|
"name": "isAuthWeakPasswordError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 146,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1008,
|
|
"name": "isAuthWeakPasswordError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1009,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1154,
|
|
"name": "AuthWeakPasswordError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 456,
|
|
"name": "navigatorLock",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 55,
|
|
"character": 22
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 457,
|
|
"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",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 458,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 459,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 460,
|
|
"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": 461,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to run once the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 462,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 463,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 458,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 458,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"kind": 128,
|
|
"children": [
|
|
1017,
|
|
1010,
|
|
1090,
|
|
1077,
|
|
1065,
|
|
1115,
|
|
1140,
|
|
1053,
|
|
1030,
|
|
1154,
|
|
1038,
|
|
1,
|
|
78,
|
|
464
|
|
]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"kind": 256,
|
|
"children": [
|
|
587,
|
|
645,
|
|
602,
|
|
807,
|
|
966,
|
|
921,
|
|
578,
|
|
656,
|
|
664,
|
|
616,
|
|
609,
|
|
639,
|
|
590,
|
|
613,
|
|
745,
|
|
737,
|
|
753
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"kind": 4194304,
|
|
"children": [
|
|
474,
|
|
473,
|
|
714,
|
|
950,
|
|
941,
|
|
963,
|
|
954,
|
|
889,
|
|
865,
|
|
910,
|
|
899,
|
|
880,
|
|
852,
|
|
517,
|
|
504,
|
|
532,
|
|
909,
|
|
977,
|
|
757,
|
|
801,
|
|
791,
|
|
810,
|
|
824,
|
|
811,
|
|
831,
|
|
796,
|
|
785,
|
|
484,
|
|
974,
|
|
475,
|
|
848,
|
|
845,
|
|
832,
|
|
837,
|
|
840,
|
|
756,
|
|
545,
|
|
991,
|
|
984,
|
|
472,
|
|
758,
|
|
558,
|
|
727,
|
|
715,
|
|
683,
|
|
697,
|
|
772,
|
|
995,
|
|
666,
|
|
973,
|
|
567,
|
|
736
|
|
]
|
|
},
|
|
{
|
|
"title": "Variables",
|
|
"kind": 32,
|
|
"children": [
|
|
469
|
|
]
|
|
},
|
|
{
|
|
"title": "Functions",
|
|
"kind": 64,
|
|
"children": [
|
|
1001,
|
|
998,
|
|
1004,
|
|
1007,
|
|
456
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 1,
|
|
"character": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 0,
|
|
"name": "@supabase/postgrest-js",
|
|
"kind": 1,
|
|
"kindString": "Project",
|
|
"flags": {},
|
|
"originalName": "",
|
|
"children": [
|
|
{
|
|
"id": 610,
|
|
"name": "PostgrestBuilder",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {
|
|
"isAbstract": true
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 611,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 612,
|
|
"name": "new PostgrestBuilder",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 613,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 614,
|
|
"name": "builder",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default",
|
|
"dereferenced": {
|
|
"id": 610,
|
|
"name": "PostgrestBuilder",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {
|
|
"isAbstract": true
|
|
},
|
|
"children": "[Circular ~.children.0.children]",
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
611
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
619,
|
|
622,
|
|
617,
|
|
627,
|
|
615,
|
|
618,
|
|
620,
|
|
621,
|
|
616
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
630,
|
|
628
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 6,
|
|
"character": 30
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 642,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 490,
|
|
"name": "PostgrestTransformBuilder"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 619,
|
|
"name": "body",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 13,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 16,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 623,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 624,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 625,
|
|
"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": 626,
|
|
"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": 617,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 627,
|
|
"name": "isMaybeSingle",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 615,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 9,
|
|
"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": 618,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 12,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"name": "shouldThrowOnError",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 14,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 621,
|
|
"name": "signal",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 15,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "AbortSignal",
|
|
"package": "typescript",
|
|
"name": "AbortSignal"
|
|
}
|
|
},
|
|
{
|
|
"id": 616,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 10,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
},
|
|
{
|
|
"id": 630,
|
|
"name": "then",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 631,
|
|
"name": "then",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 632,
|
|
"name": "TResult1",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
},
|
|
{
|
|
"id": 633,
|
|
"name": "TResult2",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 634,
|
|
"name": "onfulfilled",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 635,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 636,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 637,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 638,
|
|
"name": "onrejected",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 639,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 640,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 641,
|
|
"name": "reason",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"name": "PromiseLike.then"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"name": "PromiseLike.then"
|
|
}
|
|
},
|
|
{
|
|
"id": 628,
|
|
"name": "throwOnError",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 44,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 629,
|
|
"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": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
611
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
619,
|
|
622,
|
|
617,
|
|
627,
|
|
615,
|
|
618,
|
|
620,
|
|
621,
|
|
616
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
630,
|
|
628
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 6,
|
|
"character": 30
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 642,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 490,
|
|
"name": "PostgrestTransformBuilder"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"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": 57,
|
|
"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": 57,
|
|
"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": 38,
|
|
"name": "from",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a query on a table or a view."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 39,
|
|
"name": "relation",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The table or view name to query\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 57,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 6,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 44,
|
|
"name": "rpc",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestClient.ts",
|
|
"line": 123,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 45,
|
|
"name": "rpc",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a function call."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 46,
|
|
"name": "FunctionName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 47,
|
|
"name": "Function_",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "GenericFunction"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 48,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The function name to call"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 46,
|
|
"name": "FunctionName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 49,
|
|
"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": 47,
|
|
"name": "Function_"
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 50,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 51,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 53,
|
|
"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": 52,
|
|
"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": 133,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
53,
|
|
52
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 6,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Returns"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 47,
|
|
"name": "Function_"
|
|
}
|
|
},
|
|
"extendsType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"objectType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
"objectType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
},
|
|
"extendsType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
"objectType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Returns"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 47,
|
|
"name": "Function_"
|
|
}
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 40,
|
|
"name": "schema",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 41,
|
|
"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": 42,
|
|
"name": "DynamicSchema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 43,
|
|
"name": "schema",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The schema to query\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 42,
|
|
"name": "DynamicSchema",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 4,
|
|
"name": "Database"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 42,
|
|
"name": "DynamicSchema"
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 42,
|
|
"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,
|
|
44,
|
|
40
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestClient.ts",
|
|
"line": 17,
|
|
"character": 21
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 54,
|
|
"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": 55,
|
|
"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": 56,
|
|
"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": 144,
|
|
"name": "PostgrestFilterBuilder",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 145,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 146,
|
|
"name": "new PostgrestFilterBuilder",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 147,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "GenericSchema"
|
|
}
|
|
},
|
|
{
|
|
"id": 148,
|
|
"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": 149,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 150,
|
|
"name": "RelationName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 151,
|
|
"name": "Relationships",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 152,
|
|
"name": "builder",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default",
|
|
"dereferenced": {
|
|
"id": 610,
|
|
"name": "PostgrestBuilder",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {
|
|
"isAbstract": true
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 611,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 612,
|
|
"name": "new PostgrestBuilder",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 613,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 614,
|
|
"name": "builder",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default",
|
|
"dereferenced": "[Circular ~.children.2.children.0.signatures.0.parameters.0.type.dereferenced]"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 619,
|
|
"name": "body",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 13,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 16,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 623,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 624,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 625,
|
|
"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": 626,
|
|
"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": 617,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 627,
|
|
"name": "isMaybeSingle",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 615,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 9,
|
|
"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": 618,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 12,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"name": "shouldThrowOnError",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 14,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 621,
|
|
"name": "signal",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 15,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "AbortSignal",
|
|
"package": "typescript",
|
|
"name": "AbortSignal"
|
|
}
|
|
},
|
|
{
|
|
"id": 616,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 10,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
},
|
|
{
|
|
"id": 630,
|
|
"name": "then",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 631,
|
|
"name": "then",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 632,
|
|
"name": "TResult1",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
},
|
|
{
|
|
"id": 633,
|
|
"name": "TResult2",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 634,
|
|
"name": "onfulfilled",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 635,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 636,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 637,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 638,
|
|
"name": "onrejected",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 639,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 640,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 641,
|
|
"name": "reason",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"name": "PromiseLike.then"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"name": "PromiseLike.then"
|
|
}
|
|
},
|
|
{
|
|
"id": 628,
|
|
"name": "throwOnError",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 44,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 629,
|
|
"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": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
611
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
619,
|
|
622,
|
|
617,
|
|
627,
|
|
615,
|
|
618,
|
|
620,
|
|
621,
|
|
616
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
630,
|
|
628
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 6,
|
|
"character": 30
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 642,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 490,
|
|
"name": "PostgrestTransformBuilder"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 492,
|
|
"name": "default.constructor"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 491,
|
|
"name": "default.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 462,
|
|
"name": "body",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 13,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 582,
|
|
"name": "default.body"
|
|
}
|
|
},
|
|
{
|
|
"id": 465,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 16,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 466,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 467,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 468,
|
|
"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": 469,
|
|
"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": 585,
|
|
"name": "default.fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 460,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "default.headers"
|
|
}
|
|
},
|
|
{
|
|
"id": 470,
|
|
"name": "isMaybeSingle",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 590,
|
|
"name": "default.isMaybeSingle"
|
|
}
|
|
},
|
|
{
|
|
"id": 458,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 9,
|
|
"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": 578,
|
|
"name": "default.method"
|
|
}
|
|
},
|
|
{
|
|
"id": 461,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 12,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 581,
|
|
"name": "default.schema"
|
|
}
|
|
},
|
|
{
|
|
"id": 463,
|
|
"name": "shouldThrowOnError",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 14,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 583,
|
|
"name": "default.shouldThrowOnError"
|
|
}
|
|
},
|
|
{
|
|
"id": 464,
|
|
"name": "signal",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 15,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "AbortSignal",
|
|
"package": "typescript",
|
|
"name": "AbortSignal"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 584,
|
|
"name": "default.signal"
|
|
}
|
|
},
|
|
{
|
|
"id": 459,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 10,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 579,
|
|
"name": "default.url"
|
|
}
|
|
},
|
|
{
|
|
"id": 430,
|
|
"name": "abortSignal",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 180,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 431,
|
|
"name": "abortSignal",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Set the AbortSignal for the fetch request."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 432,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 551,
|
|
"name": "default.abortSignal"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 550,
|
|
"name": "default.abortSignal"
|
|
}
|
|
},
|
|
{
|
|
"id": 274,
|
|
"name": "containedBy",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 281,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 275,
|
|
"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": 276,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 277,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The jsonb, array, or range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 276,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 278,
|
|
"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": 276,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 279,
|
|
"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": 280,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The jsonb, array, or range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 281,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 266,
|
|
"name": "contains",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 254,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 267,
|
|
"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": 268,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 269,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The jsonb, array, or range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 268,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 270,
|
|
"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": 268,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 271,
|
|
"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": 272,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The jsonb, array, or range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 273,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 439,
|
|
"name": "csv",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 221,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 440,
|
|
"name": "csv",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Return `data` as a string in CSV format."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 560,
|
|
"name": "default.csv"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 559,
|
|
"name": "default.csv"
|
|
}
|
|
},
|
|
{
|
|
"id": 153,
|
|
"name": "eq",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 35,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 154,
|
|
"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": 155,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 156,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 155,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 157,
|
|
"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": 155,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "NonNullable",
|
|
"package": "typescript",
|
|
"name": "NonNullable"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 158,
|
|
"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": 159,
|
|
"name": "Value",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 160,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 161,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 159,
|
|
"name": "Value"
|
|
}
|
|
],
|
|
"qualifiedName": "NonNullable",
|
|
"package": "typescript",
|
|
"name": "NonNullable"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 443,
|
|
"name": "explain",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 255,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 444,
|
|
"name": "explain",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Return `data` as the EXPLAIN plan for the query."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 445,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 446,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 447,
|
|
"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": 263,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 450,
|
|
"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": 266,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 452,
|
|
"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": 268,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "text"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "json"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 449,
|
|
"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": 265,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 448,
|
|
"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": 264,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 451,
|
|
"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": 267,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
447,
|
|
450,
|
|
452,
|
|
449,
|
|
448,
|
|
451
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 610,
|
|
"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": 564,
|
|
"name": "default.explain"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 563,
|
|
"name": "default.explain"
|
|
}
|
|
},
|
|
{
|
|
"id": 369,
|
|
"name": "filter",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 508,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 370,
|
|
"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": 371,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 372,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 371,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 373,
|
|
"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": 374,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 375,
|
|
"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": 376,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "operator",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operator to filter with, following PostgREST syntax"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 378,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 441,
|
|
"name": "geojson",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 229,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 442,
|
|
"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": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 562,
|
|
"name": "default.geojson"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 561,
|
|
"name": "default.geojson"
|
|
}
|
|
},
|
|
{
|
|
"id": 170,
|
|
"name": "gt",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 66,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 171,
|
|
"name": "gt",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is greater than `value`."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 172,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 173,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 172,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 174,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 172,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 175,
|
|
"name": "gt",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is greater than `value`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 176,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 177,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 178,
|
|
"name": "gte",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 179,
|
|
"name": "gte",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is greater than or equal to `value`."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 180,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 181,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 180,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 182,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 180,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 183,
|
|
"name": "gte",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is greater than or equal to `value`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 184,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 185,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 226,
|
|
"name": "ilike",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 163,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 227,
|
|
"name": "ilike",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches `pattern` case-insensitively."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 228,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 229,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 228,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 230,
|
|
"name": "pattern",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The pattern to match with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 231,
|
|
"name": "ilike",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches `pattern` case-insensitively."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 232,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 233,
|
|
"name": "pattern",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The pattern to match with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 234,
|
|
"name": "ilikeAllOf",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 176,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 235,
|
|
"name": "ilikeAllOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches all of `patterns` case-insensitively."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 236,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 237,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 236,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 238,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 239,
|
|
"name": "ilikeAllOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches all of `patterns` case-insensitively."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 240,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 241,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 242,
|
|
"name": "ilikeAnyOf",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 192,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 243,
|
|
"name": "ilikeAnyOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches any of `patterns` case-insensitively."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 244,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 245,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 244,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 246,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 247,
|
|
"name": "ilikeAnyOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches any of `patterns` case-insensitively."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 248,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 249,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 258,
|
|
"name": "in",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 230,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 259,
|
|
"name": "in",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is included in the `values` array."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 260,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 261,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 260,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 262,
|
|
"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": 260,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 263,
|
|
"name": "in",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is included in the `values` array."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 264,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 265,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 250,
|
|
"name": "is",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 208,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 251,
|
|
"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": 252,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 253,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 252,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 254,
|
|
"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": 252,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 252,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 252,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": true
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 255,
|
|
"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": 256,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 257,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 202,
|
|
"name": "like",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 118,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 203,
|
|
"name": "like",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches `pattern` case-sensitively."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 204,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 205,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 204,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 206,
|
|
"name": "pattern",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The pattern to match with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 207,
|
|
"name": "like",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches `pattern` case-sensitively."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 208,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 209,
|
|
"name": "pattern",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The pattern to match with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 210,
|
|
"name": "likeAllOf",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 131,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 211,
|
|
"name": "likeAllOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches all of `patterns` case-sensitively."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 212,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 213,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 212,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 214,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 215,
|
|
"name": "likeAllOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches all of `patterns` case-sensitively."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 216,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 217,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 218,
|
|
"name": "likeAnyOf",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 147,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 219,
|
|
"name": "likeAnyOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches any of `patterns` case-sensitively."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 220,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 221,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 220,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 222,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 223,
|
|
"name": "likeAnyOf",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` matches any of `patterns` case-sensitively."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 224,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 225,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 415,
|
|
"name": "limit",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 416,
|
|
"name": "limit",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Limit the query result by `count`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 417,
|
|
"name": "count",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The maximum number of rows to return"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 419,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 420,
|
|
"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": 421,
|
|
"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": [
|
|
420,
|
|
421
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 536,
|
|
"name": "default.limit"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 535,
|
|
"name": "default.limit"
|
|
}
|
|
},
|
|
{
|
|
"id": 186,
|
|
"name": "lt",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 92,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 187,
|
|
"name": "lt",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is less than `value`."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 188,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 189,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 188,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 190,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 188,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 191,
|
|
"name": "lt",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is less than `value`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 192,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 193,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 194,
|
|
"name": "lte",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 105,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 195,
|
|
"name": "lte",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is less than or equal to `value`."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 196,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 197,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 196,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 198,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 196,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 199,
|
|
"name": "lte",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is less than or equal to `value`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 200,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 201,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 346,
|
|
"name": "match",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 441,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 347,
|
|
"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": 348,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 349,
|
|
"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": 348,
|
|
"name": "ColumnName"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 348,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 350,
|
|
"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": 351,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 436,
|
|
"name": "maybeSingle",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 204,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 437,
|
|
"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": 438,
|
|
"name": "ResultOne",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
"extendsType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 438,
|
|
"name": "ResultOne"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 557,
|
|
"name": "default.maybeSingle"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 556,
|
|
"name": "default.maybeSingle"
|
|
}
|
|
},
|
|
{
|
|
"id": 162,
|
|
"name": "neq",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 53,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 163,
|
|
"name": "neq",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is not equal to `value`."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 164,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 165,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 164,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 166,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"id": 164,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 167,
|
|
"name": "neq",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Match only rows where `column` is not equal to `value`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 168,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 169,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The value to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 352,
|
|
"name": "not",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 457,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 353,
|
|
"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": 354,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 355,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 354,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 356,
|
|
"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": 357,
|
|
"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": 354,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 358,
|
|
"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": 359,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 360,
|
|
"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": 361,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 362,
|
|
"name": "or",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 496,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 363,
|
|
"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": 364,
|
|
"name": "filters",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The filters to use, following PostgREST syntax"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 366,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 367,
|
|
"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": 368,
|
|
"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": [
|
|
367,
|
|
368
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "order",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 55,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 385,
|
|
"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": 386,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 387,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 386,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 389,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 390,
|
|
"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": 391,
|
|
"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": 392,
|
|
"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": [
|
|
390,
|
|
391,
|
|
392
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 505,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"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": 394,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 397,
|
|
"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": 398,
|
|
"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": 399,
|
|
"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": [
|
|
397,
|
|
398,
|
|
399
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 513,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 400,
|
|
"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": 401,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 402,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 401,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 403,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 404,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 405,
|
|
"name": "ascending",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 68,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 407,
|
|
"name": "foreignTable",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 68,
|
|
"character": 59
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
}
|
|
},
|
|
{
|
|
"id": 406,
|
|
"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": [
|
|
405,
|
|
407,
|
|
406
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 520,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 408,
|
|
"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": 409,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 410,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 411,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 412,
|
|
"name": "ascending",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 75,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 414,
|
|
"name": "foreignTable",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 75,
|
|
"character": 59
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 413,
|
|
"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": [
|
|
412,
|
|
414,
|
|
413
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 528,
|
|
"name": "default.order"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 504,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 322,
|
|
"name": "overlaps",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 380,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 323,
|
|
"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": 324,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 325,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The array or range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 324,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 326,
|
|
"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": 324,
|
|
"name": "ColumnName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 327,
|
|
"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": 328,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The array or range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 329,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "range",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 158,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"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": 424,
|
|
"name": "from",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The starting index from which to limit the result"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"name": "to",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The last index to which to limit the result"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 427,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 428,
|
|
"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": 429,
|
|
"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": [
|
|
428,
|
|
429
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 543,
|
|
"name": "default.range"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 542,
|
|
"name": "default.range"
|
|
}
|
|
},
|
|
{
|
|
"id": 314,
|
|
"name": "rangeAdjacent",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 365,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 315,
|
|
"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": 316,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 317,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 316,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 318,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 319,
|
|
"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": 320,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 321,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 282,
|
|
"name": "rangeGt",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 307,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 283,
|
|
"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": 284,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 285,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 284,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 286,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 287,
|
|
"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": 288,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 289,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 290,
|
|
"name": "rangeGte",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 321,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 291,
|
|
"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": 292,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 293,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 292,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 294,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 295,
|
|
"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": 296,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 297,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 298,
|
|
"name": "rangeLt",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 336,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 299,
|
|
"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": 300,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 301,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 300,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 302,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 303,
|
|
"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": 304,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 305,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 306,
|
|
"name": "rangeLte",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 350,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 307,
|
|
"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": 308,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 309,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 308,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 310,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 311,
|
|
"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": 312,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 313,
|
|
"name": "range",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The range to filter with\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 455,
|
|
"name": "returns",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 307,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 456,
|
|
"name": "returns",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Override the type of the returned `data`."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 457,
|
|
"name": "NewResult",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The new result type to override with\n"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 457,
|
|
"name": "NewResult"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 576,
|
|
"name": "default.returns"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 575,
|
|
"name": "default.returns"
|
|
}
|
|
},
|
|
{
|
|
"id": 453,
|
|
"name": "rollback",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 293,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 454,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 574,
|
|
"name": "default.rollback"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 573,
|
|
"name": "default.rollback"
|
|
}
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "select",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 21,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 380,
|
|
"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": 381,
|
|
"name": "Query",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "NewResultOne",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 381,
|
|
"name": "Query"
|
|
}
|
|
],
|
|
"name": "GetResult"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 383,
|
|
"name": "columns",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The columns to retrieve, separated by commas\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 381,
|
|
"name": "Query",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 382,
|
|
"name": "NewResultOne"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 500,
|
|
"name": "default.select"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 499,
|
|
"name": "default.select"
|
|
}
|
|
},
|
|
{
|
|
"id": 433,
|
|
"name": "single",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 191,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 434,
|
|
"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": 435,
|
|
"name": "ResultOne",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
"extendsType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 435,
|
|
"name": "ResultOne"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 554,
|
|
"name": "default.single"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 553,
|
|
"name": "default.single"
|
|
}
|
|
},
|
|
{
|
|
"id": 330,
|
|
"name": "textSearch",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 403,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 331,
|
|
"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": 332,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 333,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The text or tsvector column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 332,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 334,
|
|
"name": "query",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The query text to match with"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 335,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 336,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 337,
|
|
"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": 338,
|
|
"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": [
|
|
337,
|
|
338
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 339,
|
|
"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": 340,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The text or tsvector column to filter on"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 341,
|
|
"name": "query",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The query text to match with"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 342,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 343,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 344,
|
|
"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": 345,
|
|
"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": [
|
|
344,
|
|
345
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 473,
|
|
"name": "then",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 474,
|
|
"name": "then",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 475,
|
|
"name": "TResult1",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
},
|
|
{
|
|
"id": 476,
|
|
"name": "TResult2",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 477,
|
|
"name": "onfulfilled",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 478,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 479,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 480,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"name": "onrejected",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 482,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 483,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 484,
|
|
"name": "reason",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 594,
|
|
"name": "default.then"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 593,
|
|
"name": "default.then"
|
|
}
|
|
},
|
|
{
|
|
"id": 471,
|
|
"name": "throwOnError",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 44,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 472,
|
|
"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": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 592,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 591,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
145
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
462,
|
|
465,
|
|
460,
|
|
470,
|
|
458,
|
|
461,
|
|
463,
|
|
464,
|
|
459
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
430,
|
|
274,
|
|
266,
|
|
439,
|
|
153,
|
|
443,
|
|
369,
|
|
441,
|
|
170,
|
|
178,
|
|
226,
|
|
234,
|
|
242,
|
|
258,
|
|
250,
|
|
202,
|
|
210,
|
|
218,
|
|
415,
|
|
186,
|
|
194,
|
|
346,
|
|
436,
|
|
162,
|
|
352,
|
|
362,
|
|
384,
|
|
322,
|
|
422,
|
|
314,
|
|
282,
|
|
290,
|
|
298,
|
|
306,
|
|
455,
|
|
453,
|
|
379,
|
|
433,
|
|
330,
|
|
473,
|
|
471
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestFilterBuilder.ts",
|
|
"line": 28,
|
|
"character": 21
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 485,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "GenericSchema"
|
|
}
|
|
},
|
|
{
|
|
"id": 486,
|
|
"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": 487,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "RelationName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 489,
|
|
"name": "Relationships",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 147,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 148,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 149,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 150,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 151,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 57,
|
|
"name": "PostgrestQueryBuilder",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 58,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 18,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 59,
|
|
"name": "new PostgrestQueryBuilder",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 60,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "GenericSchema"
|
|
}
|
|
},
|
|
{
|
|
"id": 61,
|
|
"name": "Relation",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"name": "GenericTable"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "GenericView"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 62,
|
|
"name": "RelationName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 65,
|
|
"name": "Relationships",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 63,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 64,
|
|
"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": [
|
|
64
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"name": "R"
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 66,
|
|
"name": "url",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
},
|
|
{
|
|
"id": 67,
|
|
"name": "__namedParameters",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 68,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 71,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 27,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 72,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 73,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 74,
|
|
"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": 75,
|
|
"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": 69,
|
|
"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": 70,
|
|
"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": [
|
|
71,
|
|
69,
|
|
70
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 57,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 80,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 16,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 81,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 82,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 83,
|
|
"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": 84,
|
|
"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": 77,
|
|
"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": 78,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 14,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 79,
|
|
"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": 76,
|
|
"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": 133,
|
|
"name": "delete",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 357,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 134,
|
|
"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": 135,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 136,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 137,
|
|
"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": [
|
|
137
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 94,
|
|
"name": "insert",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 101,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 95,
|
|
"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": 96,
|
|
"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": 97,
|
|
"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": 96,
|
|
"name": "Row",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 98,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 99,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 100,
|
|
"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": [
|
|
100
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 101,
|
|
"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": 102,
|
|
"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": 103,
|
|
"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": 102,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 104,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 105,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 106,
|
|
"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": 107,
|
|
"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": [
|
|
106,
|
|
107
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 85,
|
|
"name": "select",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 86,
|
|
"name": "select",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform a SELECT query on the table or view."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 87,
|
|
"name": "Query",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
},
|
|
{
|
|
"id": 88,
|
|
"name": "ResultOne",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 87,
|
|
"name": "Query"
|
|
}
|
|
],
|
|
"name": "GetResult"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 89,
|
|
"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": 87,
|
|
"name": "Query",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 90,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 91,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 93,
|
|
"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": 92,
|
|
"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": [
|
|
93,
|
|
92
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 88,
|
|
"name": "ResultOne"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 126,
|
|
"name": "update",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 309,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 127,
|
|
"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": 128,
|
|
"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": 129,
|
|
"name": "values",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The values to update with\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 128,
|
|
"name": "Row",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 130,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 131,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 132,
|
|
"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": [
|
|
132
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 108,
|
|
"name": "upsert",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 184,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 109,
|
|
"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": 110,
|
|
"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": 111,
|
|
"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": 110,
|
|
"name": "Row",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 112,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 113,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 116,
|
|
"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": 115,
|
|
"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": 114,
|
|
"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": [
|
|
116,
|
|
115,
|
|
114
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 117,
|
|
"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": 118,
|
|
"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": 119,
|
|
"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": 118,
|
|
"name": "Row"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 120,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 121,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 124,
|
|
"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": 125,
|
|
"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": 123,
|
|
"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": 122,
|
|
"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": [
|
|
124,
|
|
125,
|
|
123,
|
|
122
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 144,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 60,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 62,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 65,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
58
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
80,
|
|
77,
|
|
78,
|
|
79,
|
|
76
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
133,
|
|
94,
|
|
85,
|
|
126,
|
|
108
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 6,
|
|
"character": 21
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 138,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "GenericSchema"
|
|
}
|
|
},
|
|
{
|
|
"id": 139,
|
|
"name": "Relation",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"name": "GenericTable"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "GenericView"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 140,
|
|
"name": "RelationName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 143,
|
|
"name": "Relationships",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 61,
|
|
"name": "Relation"
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 141,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 142,
|
|
"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": [
|
|
142
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestQueryBuilder.ts",
|
|
"line": 10,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"name": "R"
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 490,
|
|
"name": "PostgrestTransformBuilder",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 491,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 492,
|
|
"name": "new PostgrestTransformBuilder",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 493,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "GenericSchema"
|
|
}
|
|
},
|
|
{
|
|
"id": 494,
|
|
"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": 495,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"name": "RelationName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 497,
|
|
"name": "Relationships",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 498,
|
|
"name": "builder",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default",
|
|
"dereferenced": {
|
|
"id": 610,
|
|
"name": "PostgrestBuilder",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {
|
|
"isAbstract": true
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 611,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 612,
|
|
"name": "new PostgrestBuilder",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 613,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 614,
|
|
"name": "builder",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default",
|
|
"dereferenced": "[Circular ~.children.4.children.0.signatures.0.parameters.0.type.dereferenced]"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 619,
|
|
"name": "body",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 13,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 16,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 623,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 624,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 625,
|
|
"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": 626,
|
|
"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": 617,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 627,
|
|
"name": "isMaybeSingle",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 615,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 9,
|
|
"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": 618,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 12,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"name": "shouldThrowOnError",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 14,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 621,
|
|
"name": "signal",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 15,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "AbortSignal",
|
|
"package": "typescript",
|
|
"name": "AbortSignal"
|
|
}
|
|
},
|
|
{
|
|
"id": 616,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 10,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
},
|
|
{
|
|
"id": 630,
|
|
"name": "then",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 631,
|
|
"name": "then",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 632,
|
|
"name": "TResult1",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
},
|
|
{
|
|
"id": 633,
|
|
"name": "TResult2",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 634,
|
|
"name": "onfulfilled",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 635,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 636,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 637,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 638,
|
|
"name": "onrejected",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 639,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 640,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 641,
|
|
"name": "reason",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"name": "PromiseLike.then"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"name": "PromiseLike.then"
|
|
}
|
|
},
|
|
{
|
|
"id": 628,
|
|
"name": "throwOnError",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 44,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 629,
|
|
"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": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
611
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
619,
|
|
622,
|
|
617,
|
|
627,
|
|
615,
|
|
618,
|
|
620,
|
|
621,
|
|
616
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
630,
|
|
628
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 6,
|
|
"character": 30
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 642,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 490,
|
|
"name": "PostgrestTransformBuilder"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 613,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 612,
|
|
"name": "default.constructor"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 611,
|
|
"name": "default.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 582,
|
|
"name": "body",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 13,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 619,
|
|
"name": "default.body"
|
|
}
|
|
},
|
|
{
|
|
"id": 585,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 16,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 586,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 587,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 588,
|
|
"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": 589,
|
|
"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": 622,
|
|
"name": "default.fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 580,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 11,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 617,
|
|
"name": "default.headers"
|
|
}
|
|
},
|
|
{
|
|
"id": 590,
|
|
"name": "isMaybeSingle",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 627,
|
|
"name": "default.isMaybeSingle"
|
|
}
|
|
},
|
|
{
|
|
"id": 578,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 9,
|
|
"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": 615,
|
|
"name": "default.method"
|
|
}
|
|
},
|
|
{
|
|
"id": 581,
|
|
"name": "schema",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 12,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 618,
|
|
"name": "default.schema"
|
|
}
|
|
},
|
|
{
|
|
"id": 583,
|
|
"name": "shouldThrowOnError",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 14,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 620,
|
|
"name": "default.shouldThrowOnError"
|
|
}
|
|
},
|
|
{
|
|
"id": 584,
|
|
"name": "signal",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 15,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "AbortSignal",
|
|
"package": "typescript",
|
|
"name": "AbortSignal"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 621,
|
|
"name": "default.signal"
|
|
}
|
|
},
|
|
{
|
|
"id": 579,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 10,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 616,
|
|
"name": "default.url"
|
|
}
|
|
},
|
|
{
|
|
"id": 550,
|
|
"name": "abortSignal",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 180,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 551,
|
|
"name": "abortSignal",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Set the AbortSignal for the fetch request."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 552,
|
|
"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": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 559,
|
|
"name": "csv",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 221,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 560,
|
|
"name": "csv",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Return `data` as a string in CSV format."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 563,
|
|
"name": "explain",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 255,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 564,
|
|
"name": "explain",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Return `data` as the EXPLAIN plan for the query."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 565,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters\n"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 566,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 567,
|
|
"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": 263,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 570,
|
|
"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": 266,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 572,
|
|
"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": 268,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "text"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "json"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 569,
|
|
"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": 265,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 568,
|
|
"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": 264,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 571,
|
|
"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": 267,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
567,
|
|
570,
|
|
572,
|
|
569,
|
|
568,
|
|
571
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 561,
|
|
"name": "geojson",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 229,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 562,
|
|
"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": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 535,
|
|
"name": "limit",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 536,
|
|
"name": "limit",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Limit the query result by `count`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 537,
|
|
"name": "count",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The maximum number of rows to return"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 538,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 539,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 540,
|
|
"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": 541,
|
|
"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": [
|
|
540,
|
|
541
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 556,
|
|
"name": "maybeSingle",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 204,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 557,
|
|
"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": 558,
|
|
"name": "ResultOne",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
"extendsType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 438,
|
|
"name": "ResultOne"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 504,
|
|
"name": "order",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 55,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 505,
|
|
"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": 506,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 507,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 386,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 508,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 509,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 510,
|
|
"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": 511,
|
|
"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": 512,
|
|
"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": [
|
|
510,
|
|
511,
|
|
512
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 513,
|
|
"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": 514,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 515,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 516,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 517,
|
|
"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": 518,
|
|
"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": 519,
|
|
"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": [
|
|
517,
|
|
518,
|
|
519
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 520,
|
|
"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": 521,
|
|
"name": "ColumnName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 522,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 401,
|
|
"name": "ColumnName",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 523,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 524,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 525,
|
|
"name": "ascending",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 68,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 527,
|
|
"name": "foreignTable",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 68,
|
|
"character": 59
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
}
|
|
},
|
|
{
|
|
"id": 526,
|
|
"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": [
|
|
525,
|
|
527,
|
|
526
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 528,
|
|
"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": 529,
|
|
"name": "column",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The column to order by"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 530,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 531,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 532,
|
|
"name": "ascending",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 75,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 534,
|
|
"name": "foreignTable",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 75,
|
|
"character": 59
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 533,
|
|
"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": [
|
|
532,
|
|
534,
|
|
533
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 542,
|
|
"name": "range",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 158,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 543,
|
|
"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": 544,
|
|
"name": "from",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The starting index from which to limit the result"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 545,
|
|
"name": "to",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The last index to which to limit the result"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 546,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Named parameters"
|
|
},
|
|
"originalName": "__namedParameters",
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 547,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 548,
|
|
"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": 549,
|
|
"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": [
|
|
548,
|
|
549
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 575,
|
|
"name": "returns",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 307,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 576,
|
|
"name": "returns",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Override the type of the returned `data`."
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 577,
|
|
"name": "NewResult",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The new result type to override with\n"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 457,
|
|
"name": "NewResult"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 573,
|
|
"name": "rollback",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 293,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 574,
|
|
"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": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 499,
|
|
"name": "select",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 21,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 500,
|
|
"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": 501,
|
|
"name": "Query",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
},
|
|
{
|
|
"id": 502,
|
|
"name": "NewResultOne",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 381,
|
|
"name": "Query"
|
|
}
|
|
],
|
|
"name": "GetResult"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 503,
|
|
"name": "columns",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The columns to retrieve, separated by commas\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 381,
|
|
"name": "Query",
|
|
"dereferenced": {}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 382,
|
|
"name": "NewResultOne"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 553,
|
|
"name": "single",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 191,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 554,
|
|
"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": 555,
|
|
"name": "ResultOne",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
"extendsType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"name": "ResultOne"
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 435,
|
|
"name": "ResultOne"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 593,
|
|
"name": "then",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 49,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 594,
|
|
"name": "then",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"typeParameter": [
|
|
{
|
|
"id": 595,
|
|
"name": "TResult1",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
},
|
|
{
|
|
"id": 596,
|
|
"name": "TResult2",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 597,
|
|
"name": "onfulfilled",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 598,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 599,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 600,
|
|
"name": "value",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 601,
|
|
"name": "onrejected",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 602,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 603,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 604,
|
|
"name": "reason",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 475,
|
|
"name": "TResult1"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 476,
|
|
"name": "TResult2"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "PromiseLike",
|
|
"package": "typescript",
|
|
"name": "PromiseLike"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 631,
|
|
"name": "default.then"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 630,
|
|
"name": "default.then"
|
|
}
|
|
},
|
|
{
|
|
"id": 591,
|
|
"name": "throwOnError",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestBuilder.ts",
|
|
"line": 44,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 592,
|
|
"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": 490,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 493,
|
|
"name": "Schema"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 494,
|
|
"name": "Row"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 496,
|
|
"name": "RelationName"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 497,
|
|
"name": "Relationships"
|
|
}
|
|
],
|
|
"name": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 629,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 628,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
491
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
582,
|
|
585,
|
|
580,
|
|
590,
|
|
578,
|
|
581,
|
|
583,
|
|
584,
|
|
579
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
550,
|
|
559,
|
|
563,
|
|
561,
|
|
535,
|
|
556,
|
|
504,
|
|
542,
|
|
575,
|
|
573,
|
|
499,
|
|
553,
|
|
593,
|
|
591
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/PostgrestTransformBuilder.ts",
|
|
"line": 5,
|
|
"character": 21
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 605,
|
|
"name": "Schema",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "GenericSchema"
|
|
}
|
|
},
|
|
{
|
|
"id": 606,
|
|
"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": 607,
|
|
"name": "Result",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 608,
|
|
"name": "RelationName",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 609,
|
|
"name": "Relationships",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 610,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 495,
|
|
"name": "Result"
|
|
}
|
|
],
|
|
"name": "default"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 144,
|
|
"name": "PostgrestFilterBuilder"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 645,
|
|
"name": "PostgrestResponseFailure",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 648,
|
|
"name": "count",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 32,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 647,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 30,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 662,
|
|
"name": "PostgrestError",
|
|
"dereferenced": {
|
|
"id": 662,
|
|
"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": 663,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 667,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 12,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 665,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 10,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 666,
|
|
"name": "hint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 664,
|
|
"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": [
|
|
667,
|
|
665,
|
|
666,
|
|
664
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 8,
|
|
"character": 29
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"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": 650,
|
|
"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": [
|
|
648,
|
|
647,
|
|
646,
|
|
649,
|
|
650
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 29,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "PostgrestResponseBase"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 651,
|
|
"name": "PostgrestResponseSuccess",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 654,
|
|
"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": 653,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 26,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 25,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"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": 656,
|
|
"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": [
|
|
654,
|
|
653,
|
|
652,
|
|
655,
|
|
656
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 24,
|
|
"character": 17
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 657,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "PostgrestResponseBase"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 662,
|
|
"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": 663,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 667,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 12,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 665,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 10,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 666,
|
|
"name": "hint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 664,
|
|
"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": [
|
|
667,
|
|
665,
|
|
666,
|
|
664
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 8,
|
|
"character": 29
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 660,
|
|
"name": "PostgrestMaybeSingleResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 39,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 661,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 661,
|
|
"name": "T"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
},
|
|
{
|
|
"id": 643,
|
|
"name": "PostgrestResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 40,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 644,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 658,
|
|
"typeArguments": [
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 644,
|
|
"name": "T"
|
|
}
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse"
|
|
}
|
|
},
|
|
{
|
|
"id": 658,
|
|
"name": "PostgrestSingleResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 38,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 659,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 651,
|
|
"name": "PostgrestResponseSuccess",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 654,
|
|
"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": 653,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 26,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 25,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"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": 656,
|
|
"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": [
|
|
654,
|
|
653,
|
|
652,
|
|
655,
|
|
656
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 24,
|
|
"character": 17
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 657,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "PostgrestResponseBase"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 645,
|
|
"name": "PostgrestResponseFailure",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 648,
|
|
"name": "count",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 32,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 647,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 30,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 662,
|
|
"name": "PostgrestError",
|
|
"dereferenced": {
|
|
"id": 662,
|
|
"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": 663,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 667,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 12,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 665,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 10,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 666,
|
|
"name": "hint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 664,
|
|
"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": [
|
|
667,
|
|
665,
|
|
666,
|
|
664
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 8,
|
|
"character": 29
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"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": 650,
|
|
"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": [
|
|
648,
|
|
647,
|
|
646,
|
|
649,
|
|
650
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 29,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "PostgrestResponseBase"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"kind": 128,
|
|
"children": [
|
|
610,
|
|
1,
|
|
144,
|
|
57,
|
|
490
|
|
]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"kind": 256,
|
|
"children": [
|
|
645,
|
|
651
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"kind": 4194304,
|
|
"children": [
|
|
662,
|
|
660,
|
|
643,
|
|
658
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 1,
|
|
"character": 0
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 0,
|
|
"name": "@supabase/realtime-js",
|
|
"kind": 1,
|
|
"kindString": "Project",
|
|
"flags": {},
|
|
"originalName": "",
|
|
"children": [
|
|
{
|
|
"id": 576,
|
|
"name": "REALTIME_LISTEN_TYPES",
|
|
"kind": 8,
|
|
"kindString": "Enumeration",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 577,
|
|
"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": 579,
|
|
"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": 578,
|
|
"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": [
|
|
577,
|
|
579,
|
|
578
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 92,
|
|
"character": 12
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT",
|
|
"kind": 8,
|
|
"kindString": "Enumeration",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 581,
|
|
"name": "ALL",
|
|
"kind": 16,
|
|
"kindString": "Enumeration Member",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "*"
|
|
},
|
|
"defaultValue": "\"*\""
|
|
},
|
|
{
|
|
"id": 584,
|
|
"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": 582,
|
|
"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": 583,
|
|
"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": [
|
|
581,
|
|
584,
|
|
582,
|
|
583
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 85,
|
|
"character": 12
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 585,
|
|
"name": "REALTIME_PRESENCE_LISTEN_EVENTS",
|
|
"kind": 8,
|
|
"kindString": "Enumeration",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 587,
|
|
"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": 588,
|
|
"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": 586,
|
|
"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": [
|
|
587,
|
|
588,
|
|
586
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 35,
|
|
"character": 12
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 589,
|
|
"name": "REALTIME_SUBSCRIBE_STATES",
|
|
"kind": 8,
|
|
"kindString": "Enumeration",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 593,
|
|
"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": 592,
|
|
"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": 590,
|
|
"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": 591,
|
|
"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": [
|
|
593,
|
|
592,
|
|
590,
|
|
591
|
|
]
|
|
}
|
|
],
|
|
"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": 115,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"dereferenced": {
|
|
"id": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"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": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "channels",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 64,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 386,
|
|
"name": "conn",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "WebSocketLike"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "decode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "encode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 82,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 366,
|
|
"name": "endPoint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "''"
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 99,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 397,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 398,
|
|
"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": 399,
|
|
"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": 367,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 72,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 368,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 369,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 370,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "DEFAULT_HEADERS"
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 76,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "30000"
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "heartbeatTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "global.NodeJS.Timer",
|
|
"package": "@types/node",
|
|
"name": "Timer"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "undefined"
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "logger",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 81,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
},
|
|
"defaultValue": "noop"
|
|
},
|
|
{
|
|
"id": 371,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 373,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "pendingHeartbeatRef",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 385,
|
|
"name": "reconnectAfterMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 84,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "reconnectTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 80,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "0"
|
|
},
|
|
{
|
|
"id": 387,
|
|
"name": "sendBuffer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "serializer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 87,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 389,
|
|
"name": "stateChangeCallbacks",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 390,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "close",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 90,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 91,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 92,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "open",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
392,
|
|
393,
|
|
394,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 375,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "DEFAULT_TIMEOUT"
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "transport",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "WebSocketLikeConstructor"
|
|
},
|
|
"defaultValue": "WebSocketVariant"
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"name": "topic",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 400,
|
|
"name": "connect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 153,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 401,
|
|
"name": "connect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Connects the socket, unless already connected."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "connectionState",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 419,
|
|
"name": "connectionState",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the current state of the socket."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "CONNECTION_STATE"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "disconnect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 182,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 403,
|
|
"name": "disconnect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Disconnects the socket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 404,
|
|
"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": 405,
|
|
"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": 406,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 200,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 407,
|
|
"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": 420,
|
|
"name": "isConnected",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 257,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 421,
|
|
"name": "isConnected",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns `true` is the connection is open."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "log",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 234,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "kind",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "msg",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "push",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 275,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": 428,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"dereferenced": {
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 208,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 409,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes a single channel"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 410,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"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": 431,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 566,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 41,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
],
|
|
"name": "RealtimePresenceState",
|
|
"dereferenced": {
|
|
"id": 566,
|
|
"name": "RealtimePresenceState",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 574,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 570,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 44
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 571,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 572,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 573,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 69
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 567,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 75
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 568,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 569,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 574,
|
|
"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": 115,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"dereferenced": {
|
|
"id": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"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": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "channels",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 64,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 386,
|
|
"name": "conn",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "WebSocketLike"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "decode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "encode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 82,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 366,
|
|
"name": "endPoint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "''"
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 99,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 397,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 398,
|
|
"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": 399,
|
|
"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": 367,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 72,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 368,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 369,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 370,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "DEFAULT_HEADERS"
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 76,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "30000"
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "heartbeatTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "global.NodeJS.Timer",
|
|
"package": "@types/node",
|
|
"name": "Timer"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "undefined"
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "logger",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 81,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
},
|
|
"defaultValue": "noop"
|
|
},
|
|
{
|
|
"id": 371,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 373,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "pendingHeartbeatRef",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 385,
|
|
"name": "reconnectAfterMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 84,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "reconnectTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 80,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "0"
|
|
},
|
|
{
|
|
"id": 387,
|
|
"name": "sendBuffer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "serializer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 87,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 389,
|
|
"name": "stateChangeCallbacks",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 390,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "close",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 90,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 91,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 92,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "open",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
392,
|
|
393,
|
|
394,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 375,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "DEFAULT_TIMEOUT"
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "transport",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "WebSocketLikeConstructor"
|
|
},
|
|
"defaultValue": "WebSocketVariant"
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"name": "topic",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 400,
|
|
"name": "connect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 153,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 401,
|
|
"name": "connect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Connects the socket, unless already connected."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "connectionState",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 419,
|
|
"name": "connectionState",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the current state of the socket."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "CONNECTION_STATE"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "disconnect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 182,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 403,
|
|
"name": "disconnect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Disconnects the socket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 404,
|
|
"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": 405,
|
|
"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": 406,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 200,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 407,
|
|
"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": 420,
|
|
"name": "isConnected",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 257,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 421,
|
|
"name": "isConnected",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns `true` is the connection is open."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "log",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 234,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "kind",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "msg",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "push",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 275,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": 428,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"dereferenced": {
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 208,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 409,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes a single channel"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 410,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"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": 431,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 546,
|
|
"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": 556,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 512,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "INSERT"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 517,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "UPDATE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 527,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "DELETE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 536,
|
|
"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": 566,
|
|
"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": 115,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"dereferenced": {
|
|
"id": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"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": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "channels",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 64,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 386,
|
|
"name": "conn",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "WebSocketLike"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "decode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "encode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 82,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 366,
|
|
"name": "endPoint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "''"
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 99,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 397,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 398,
|
|
"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": 399,
|
|
"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": 367,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 72,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 368,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 369,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 370,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "DEFAULT_HEADERS"
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 76,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "30000"
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "heartbeatTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "global.NodeJS.Timer",
|
|
"package": "@types/node",
|
|
"name": "Timer"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "undefined"
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "logger",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 81,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
},
|
|
"defaultValue": "noop"
|
|
},
|
|
{
|
|
"id": 371,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 373,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "pendingHeartbeatRef",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 385,
|
|
"name": "reconnectAfterMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 84,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "reconnectTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 80,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "0"
|
|
},
|
|
{
|
|
"id": 387,
|
|
"name": "sendBuffer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "serializer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 87,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 389,
|
|
"name": "stateChangeCallbacks",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 390,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "close",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 90,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 91,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 92,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "open",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
392,
|
|
393,
|
|
394,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 375,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "DEFAULT_TIMEOUT"
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "transport",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "WebSocketLikeConstructor"
|
|
},
|
|
"defaultValue": "WebSocketVariant"
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"name": "topic",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 400,
|
|
"name": "connect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 153,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 401,
|
|
"name": "connect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Connects the socket, unless already connected."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "connectionState",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 419,
|
|
"name": "connectionState",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the current state of the socket."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "CONNECTION_STATE"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "disconnect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 182,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 403,
|
|
"name": "disconnect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Disconnects the socket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 404,
|
|
"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": 405,
|
|
"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": 406,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 200,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 407,
|
|
"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": 420,
|
|
"name": "isConnected",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 257,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 421,
|
|
"name": "isConnected",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns `true` is the connection is open."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "log",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 234,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "kind",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "msg",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "push",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 275,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": 428,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"dereferenced": {
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 208,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 409,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes a single channel"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 410,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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.31.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.31.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": 566,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 41,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
],
|
|
"name": "RealtimePresenceState",
|
|
"dereferenced": {
|
|
"id": 566,
|
|
"name": "RealtimePresenceState",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 574,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 570,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 44
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 571,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 572,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 573,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 69
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 567,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 75
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 568,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 569,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 574,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 546,
|
|
"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": 556,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 512,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "INSERT"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 517,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "UPDATE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 527,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "DELETE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 536,
|
|
"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": 566,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"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": 431,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 115,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"dereferenced": {
|
|
"id": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"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": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "channels",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 64,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 386,
|
|
"name": "conn",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "WebSocketLike"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "decode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "encode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 82,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 366,
|
|
"name": "endPoint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "''"
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 99,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 397,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 398,
|
|
"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": 399,
|
|
"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": 367,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 72,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 368,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 369,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 370,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "DEFAULT_HEADERS"
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 76,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "30000"
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "heartbeatTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "global.NodeJS.Timer",
|
|
"package": "@types/node",
|
|
"name": "Timer"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "undefined"
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "logger",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 81,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
},
|
|
"defaultValue": "noop"
|
|
},
|
|
{
|
|
"id": 371,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 373,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "pendingHeartbeatRef",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 385,
|
|
"name": "reconnectAfterMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 84,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "reconnectTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 80,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "0"
|
|
},
|
|
{
|
|
"id": 387,
|
|
"name": "sendBuffer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "serializer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 87,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 389,
|
|
"name": "stateChangeCallbacks",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 390,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "close",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 90,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 91,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 92,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "open",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
392,
|
|
393,
|
|
394,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 375,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "DEFAULT_TIMEOUT"
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "transport",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "WebSocketLikeConstructor"
|
|
},
|
|
"defaultValue": "WebSocketVariant"
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"name": "topic",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 400,
|
|
"name": "connect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 153,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 401,
|
|
"name": "connect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Connects the socket, unless already connected."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "connectionState",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 419,
|
|
"name": "connectionState",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the current state of the socket."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "CONNECTION_STATE"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "disconnect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 182,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 403,
|
|
"name": "disconnect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Disconnects the socket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 404,
|
|
"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": 405,
|
|
"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": 406,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 200,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 407,
|
|
"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": 420,
|
|
"name": "isConnected",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 257,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 421,
|
|
"name": "isConnected",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns `true` is the connection is open."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "log",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 234,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "kind",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "msg",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "push",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 275,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": 428,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"dereferenced": {
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 208,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 409,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes a single channel"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 410,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"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": 431,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 115,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"dereferenced": {
|
|
"id": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"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": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "channels",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 64,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 386,
|
|
"name": "conn",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "WebSocketLike"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "decode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "encode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 82,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 366,
|
|
"name": "endPoint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "''"
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 99,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 397,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 398,
|
|
"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": 399,
|
|
"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": 367,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 72,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 368,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 369,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 370,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "DEFAULT_HEADERS"
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 76,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "30000"
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "heartbeatTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "global.NodeJS.Timer",
|
|
"package": "@types/node",
|
|
"name": "Timer"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "undefined"
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "logger",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 81,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
},
|
|
"defaultValue": "noop"
|
|
},
|
|
{
|
|
"id": 371,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 373,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "pendingHeartbeatRef",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 385,
|
|
"name": "reconnectAfterMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 84,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "reconnectTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 80,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "0"
|
|
},
|
|
{
|
|
"id": 387,
|
|
"name": "sendBuffer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "serializer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 87,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 389,
|
|
"name": "stateChangeCallbacks",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 390,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "close",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 90,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 91,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 92,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "open",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
392,
|
|
393,
|
|
394,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 375,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "DEFAULT_TIMEOUT"
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "transport",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "WebSocketLikeConstructor"
|
|
},
|
|
"defaultValue": "WebSocketVariant"
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"name": "topic",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 400,
|
|
"name": "connect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 153,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 401,
|
|
"name": "connect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Connects the socket, unless already connected."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "connectionState",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 419,
|
|
"name": "connectionState",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the current state of the socket."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "CONNECTION_STATE"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "disconnect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 182,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 403,
|
|
"name": "disconnect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Disconnects the socket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 404,
|
|
"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": 405,
|
|
"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": 406,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 200,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 407,
|
|
"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": 420,
|
|
"name": "isConnected",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 257,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 421,
|
|
"name": "isConnected",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns `true` is the connection is open."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "log",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 234,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "kind",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "msg",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "push",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 275,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": 428,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"dereferenced": {
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 208,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 409,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes a single channel"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 410,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"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": 431,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 546,
|
|
"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": 556,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 512,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "INSERT"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 517,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "UPDATE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 527,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "DELETE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 536,
|
|
"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": 566,
|
|
"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": 115,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"dereferenced": {
|
|
"id": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"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": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "channels",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 64,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 386,
|
|
"name": "conn",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "WebSocketLike"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "decode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "encode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 82,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 366,
|
|
"name": "endPoint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "''"
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 99,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 397,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 398,
|
|
"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": 399,
|
|
"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": 367,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 72,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 368,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 369,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 370,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "DEFAULT_HEADERS"
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 76,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "30000"
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "heartbeatTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "global.NodeJS.Timer",
|
|
"package": "@types/node",
|
|
"name": "Timer"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "undefined"
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "logger",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 81,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
},
|
|
"defaultValue": "noop"
|
|
},
|
|
{
|
|
"id": 371,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 373,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "pendingHeartbeatRef",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 385,
|
|
"name": "reconnectAfterMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 84,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "reconnectTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 80,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "0"
|
|
},
|
|
{
|
|
"id": 387,
|
|
"name": "sendBuffer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "serializer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 87,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 389,
|
|
"name": "stateChangeCallbacks",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 390,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "close",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 90,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 91,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 92,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "open",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
392,
|
|
393,
|
|
394,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 375,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "DEFAULT_TIMEOUT"
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "transport",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "WebSocketLikeConstructor"
|
|
},
|
|
"defaultValue": "WebSocketVariant"
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"name": "topic",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 400,
|
|
"name": "connect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 153,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 401,
|
|
"name": "connect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Connects the socket, unless already connected."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "connectionState",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 419,
|
|
"name": "connectionState",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the current state of the socket."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "CONNECTION_STATE"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "disconnect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 182,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 403,
|
|
"name": "disconnect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Disconnects the socket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 404,
|
|
"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": 405,
|
|
"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": 406,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 200,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 407,
|
|
"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": 420,
|
|
"name": "isConnected",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 257,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 421,
|
|
"name": "isConnected",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns `true` is the connection is open."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "log",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 234,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "kind",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "msg",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "push",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 275,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": 428,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"dereferenced": {
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 208,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 409,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes a single channel"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 410,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"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": 431,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 115,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"dereferenced": {
|
|
"id": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"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": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "channels",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 70,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 64,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 386,
|
|
"name": "conn",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 85,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "WebSocketLike"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "decode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "encode",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 82,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 366,
|
|
"name": "endPoint",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "''"
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 99,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 397,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 398,
|
|
"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": 399,
|
|
"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": 367,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 72,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 368,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 369,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 370,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "DEFAULT_HEADERS"
|
|
},
|
|
{
|
|
"id": 377,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 76,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "30000"
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "heartbeatTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "global.NodeJS.Timer",
|
|
"package": "@types/node",
|
|
"name": "Timer"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "undefined"
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "logger",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 81,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
},
|
|
"defaultValue": "noop"
|
|
},
|
|
{
|
|
"id": 371,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 373,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "pendingHeartbeatRef",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 78,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 385,
|
|
"name": "reconnectAfterMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 84,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "reconnectTimer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 80,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 79,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "0"
|
|
},
|
|
{
|
|
"id": 387,
|
|
"name": "sendBuffer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 86,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
},
|
|
"defaultValue": "[]"
|
|
},
|
|
{
|
|
"id": 388,
|
|
"name": "serializer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 87,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "default"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 389,
|
|
"name": "stateChangeCallbacks",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 390,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "close",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 90,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 91,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 92,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"qualifiedName": "Function",
|
|
"package": "typescript",
|
|
"name": "Function"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "open",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
392,
|
|
393,
|
|
394,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 375,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 74,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "DEFAULT_TIMEOUT"
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "transport",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "WebSocketLikeConstructor"
|
|
},
|
|
"defaultValue": "WebSocketVariant"
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "channel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 261,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "channel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"name": "topic",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 400,
|
|
"name": "connect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 153,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 401,
|
|
"name": "connect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Connects the socket, unless already connected."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "connectionState",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 419,
|
|
"name": "connectionState",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the current state of the socket."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "CONNECTION_STATE"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "disconnect",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 182,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 403,
|
|
"name": "disconnect",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Disconnects the socket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 404,
|
|
"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": 405,
|
|
"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": 406,
|
|
"name": "getChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 200,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 407,
|
|
"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": 420,
|
|
"name": "isConnected",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 257,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 421,
|
|
"name": "isConnected",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns `true` is the connection is open."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "log",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 234,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"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": 415,
|
|
"name": "kind",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "msg",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "push",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 275,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": 428,
|
|
"name": "data",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"dereferenced": {
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "removeAllChannels",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "removeChannel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 208,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 409,
|
|
"name": "removeChannel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unsubscribes and removes a single channel"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 410,
|
|
"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": 575,
|
|
"name": "RealtimeRemoveChannelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 295,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"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": 431,
|
|
"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,
|
|
386,
|
|
384,
|
|
383,
|
|
366,
|
|
395,
|
|
367,
|
|
377,
|
|
378,
|
|
382,
|
|
371,
|
|
379,
|
|
385,
|
|
381,
|
|
380,
|
|
387,
|
|
388,
|
|
389,
|
|
375,
|
|
376
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
422,
|
|
400,
|
|
418,
|
|
402,
|
|
406,
|
|
420,
|
|
413,
|
|
426,
|
|
411,
|
|
408,
|
|
429
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 68,
|
|
"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": 546,
|
|
"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": 556,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 512,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "INSERT"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 517,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "UPDATE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 527,
|
|
"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": 505,
|
|
"typeArguments": [
|
|
{
|
|
"type": "literal",
|
|
"value": "DELETE"
|
|
}
|
|
],
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"dereferenced": {
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"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": 536,
|
|
"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": 566,
|
|
"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": 566,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 41,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
],
|
|
"name": "RealtimePresenceState",
|
|
"dereferenced": {
|
|
"id": 566,
|
|
"name": "RealtimePresenceState",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 574,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 570,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 44
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 571,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 572,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 573,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 69
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 567,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 75
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 568,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 569,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 574,
|
|
"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": 479,
|
|
"name": "RealtimeClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 486,
|
|
"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": 485,
|
|
"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": 497,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 489,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 490,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 483,
|
|
"name": "heartbeatIntervalMs",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"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": 484,
|
|
"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": 492,
|
|
"name": "params",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 493,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 29,
|
|
"character": 11
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 494,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 487,
|
|
"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": 482,
|
|
"name": "timeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 22,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"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": [
|
|
486,
|
|
485,
|
|
497,
|
|
488,
|
|
483,
|
|
496,
|
|
484,
|
|
492,
|
|
487,
|
|
482,
|
|
481
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 20,
|
|
"character": 36
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 498,
|
|
"name": "RealtimeMessage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 499,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 501,
|
|
"name": "event",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 36,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"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": 502,
|
|
"name": "payload",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 37,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "ref",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 38,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"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": [
|
|
501,
|
|
504,
|
|
502,
|
|
503,
|
|
500
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeClient.ts",
|
|
"line": 34,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 505,
|
|
"name": "RealtimePostgresChangesFilter",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 62,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 511,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "template-literal",
|
|
"head": "",
|
|
"tail": [
|
|
[
|
|
{
|
|
"type": "reference",
|
|
"id": 580,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 507,
|
|
"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": 511,
|
|
"name": "T",
|
|
"dereferenced": {}
|
|
}
|
|
},
|
|
{
|
|
"id": 510,
|
|
"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": 508,
|
|
"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": 509,
|
|
"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": [
|
|
507,
|
|
510,
|
|
508,
|
|
509
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 64,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 512,
|
|
"name": "RealtimePostgresChangesPayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 57,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 516,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 513,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 57,
|
|
"character": 53
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 514,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 515,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 517,
|
|
"name": "RealtimePostgresInsertPayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 36,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 526,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 523,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 36,
|
|
"character": 52
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 524,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 525,
|
|
"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": 518,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 519,
|
|
"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": 582,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 520,
|
|
"name": "new",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 39,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "T"
|
|
}
|
|
},
|
|
{
|
|
"id": 521,
|
|
"name": "old",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 40,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 522,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 40,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
519,
|
|
520,
|
|
521
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 37,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 527,
|
|
"name": "RealtimePostgresUpdatePayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 43,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 535,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 532,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 43,
|
|
"character": 52
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 533,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 534,
|
|
"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": 528,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 529,
|
|
"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": 583,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 530,
|
|
"name": "new",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 46,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 535,
|
|
"name": "T"
|
|
}
|
|
},
|
|
{
|
|
"id": 531,
|
|
"name": "old",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 47,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 535,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"qualifiedName": "Partial",
|
|
"package": "typescript",
|
|
"name": "Partial"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
529,
|
|
530,
|
|
531
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 44,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 536,
|
|
"name": "RealtimePostgresDeletePayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 50,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 545,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 542,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 50,
|
|
"character": 52
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 543,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 544,
|
|
"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": 537,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 538,
|
|
"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": 584,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 539,
|
|
"name": "new",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 53,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 540,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 53,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 541,
|
|
"name": "old",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 54,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 545,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"qualifiedName": "Partial",
|
|
"package": "typescript",
|
|
"name": "Partial"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
538,
|
|
539,
|
|
541
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 51,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 536,
|
|
"name": "RealtimePostgresDeletePayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 50,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 545,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 542,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 50,
|
|
"character": 52
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 543,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 544,
|
|
"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": 537,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 538,
|
|
"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": 584,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 539,
|
|
"name": "new",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 53,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 540,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 53,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 541,
|
|
"name": "old",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 54,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 545,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"qualifiedName": "Partial",
|
|
"package": "typescript",
|
|
"name": "Partial"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
538,
|
|
539,
|
|
541
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 51,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 517,
|
|
"name": "RealtimePostgresInsertPayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 36,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 526,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 523,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 36,
|
|
"character": 52
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 524,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 525,
|
|
"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": 518,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 519,
|
|
"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": 582,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 520,
|
|
"name": "new",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 39,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "T"
|
|
}
|
|
},
|
|
{
|
|
"id": 521,
|
|
"name": "old",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 40,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 522,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 40,
|
|
"character": 9
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
519,
|
|
520,
|
|
521
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 37,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 527,
|
|
"name": "RealtimePostgresUpdatePayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 43,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 535,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 532,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 43,
|
|
"character": 52
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 533,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 534,
|
|
"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": 528,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 529,
|
|
"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": 583,
|
|
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 530,
|
|
"name": "new",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 46,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 535,
|
|
"name": "T"
|
|
}
|
|
},
|
|
{
|
|
"id": 531,
|
|
"name": "old",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 47,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 535,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"qualifiedName": "Partial",
|
|
"package": "typescript",
|
|
"name": "Partial"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
529,
|
|
530,
|
|
531
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimeChannel.ts",
|
|
"line": 44,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 546,
|
|
"name": "RealtimePresenceJoinPayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 21,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 555,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 552,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 21,
|
|
"character": 50
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 553,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 554,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 547,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 550,
|
|
"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": 555,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"name": "Presence"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 548,
|
|
"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": 587,
|
|
"name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 549,
|
|
"name": "key",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 551,
|
|
"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": 555,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"name": "Presence"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
550,
|
|
548,
|
|
549,
|
|
551
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 21,
|
|
"character": 76
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 556,
|
|
"name": "RealtimePresenceLeavePayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 28,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 565,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 562,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 28,
|
|
"character": 51
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 563,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 564,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 557,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 560,
|
|
"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": 565,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"name": "Presence"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 558,
|
|
"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": 588,
|
|
"name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE"
|
|
},
|
|
""
|
|
]
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 559,
|
|
"name": "key",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 30,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 561,
|
|
"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": 565,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"name": "Presence"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
560,
|
|
558,
|
|
559,
|
|
561
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 28,
|
|
"character": 77
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 566,
|
|
"name": "RealtimePresenceState",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 574,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 570,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 44
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 571,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 572,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 573,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 69
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 567,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/RealtimePresence.ts",
|
|
"line": 17,
|
|
"character": 75
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 568,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 569,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 574,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"name": "Presence"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 575,
|
|
"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": 594,
|
|
"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": [
|
|
576,
|
|
580,
|
|
585,
|
|
589
|
|
]
|
|
},
|
|
{
|
|
"title": "Classes",
|
|
"kind": 128,
|
|
"children": [
|
|
64,
|
|
359,
|
|
1
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"kind": 4194304,
|
|
"children": [
|
|
347,
|
|
358,
|
|
479,
|
|
498,
|
|
505,
|
|
512,
|
|
536,
|
|
517,
|
|
527,
|
|
546,
|
|
556,
|
|
566,
|
|
575
|
|
]
|
|
},
|
|
{
|
|
"title": "Variables",
|
|
"kind": 32,
|
|
"children": [
|
|
594
|
|
]
|
|
}
|
|
],
|
|
"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": 445,
|
|
"name": "StorageApiError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 446,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 17,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 447,
|
|
"name": "new StorageApiError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 448,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 449,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 445,
|
|
"name": "StorageApiError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 442,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 441,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 450,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 15,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 451,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 23,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 452,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 453,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 455,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 26,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 454,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 25,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 456,
|
|
"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": [
|
|
455,
|
|
454,
|
|
456
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
446
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
450
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
451
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 14,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 300,
|
|
"name": "StorageClient",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 301,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/StorageClient.ts",
|
|
"line": 6,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 302,
|
|
"name": "new StorageClient",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 303,
|
|
"name": "url",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 304,
|
|
"name": "headers",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 305,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 306,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 307,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 308,
|
|
"name": "fetch",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 309,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 310,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 311,
|
|
"name": "input",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInfo",
|
|
"package": "typescript",
|
|
"name": "RequestInfo"
|
|
}
|
|
},
|
|
{
|
|
"id": 312,
|
|
"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": 300,
|
|
"name": "StorageClient"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 5,
|
|
"name": "default.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 4,
|
|
"name": "default.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 343,
|
|
"name": "createBucket",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 85,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 344,
|
|
"name": "createBucket",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Creates a new Storage bucket",
|
|
"returns": "newly created bucket id\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 345,
|
|
"name": "id",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "A unique identifier for the bucket you are creating."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 346,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 347,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 350,
|
|
"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": 349,
|
|
"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": 348,
|
|
"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": [
|
|
350,
|
|
349,
|
|
348
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"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/packages/StorageBucketApi.ts",
|
|
"line": 96,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 395,
|
|
"name": "Bucket"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "name"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 353,
|
|
"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": [
|
|
352,
|
|
353
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 354,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 355,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 100,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 356,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 101,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
355,
|
|
356
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 44,
|
|
"name": "default.createBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 43,
|
|
"name": "default.createBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 384,
|
|
"name": "deleteBucket",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 219,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 385,
|
|
"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": 386,
|
|
"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": 387,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 388,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 223,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 389,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 390,
|
|
"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": [
|
|
390
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"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": [
|
|
388,
|
|
391
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 392,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 393,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 227,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 394,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 228,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
393,
|
|
394
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 85,
|
|
"name": "default.deleteBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 84,
|
|
"name": "default.deleteBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 373,
|
|
"name": "emptyBucket",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 184,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 374,
|
|
"name": "emptyBucket",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Removes all objects inside a single bucket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 375,
|
|
"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": 376,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 377,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 188,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 378,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 379,
|
|
"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": [
|
|
379
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 380,
|
|
"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": [
|
|
377,
|
|
380
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 381,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 382,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 192,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 383,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 193,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
382,
|
|
383
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 74,
|
|
"name": "default.emptyBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 73,
|
|
"name": "default.emptyBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 313,
|
|
"name": "from",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/StorageClient.ts",
|
|
"line": 15,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 314,
|
|
"name": "from",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Perform file operation in a bucket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 315,
|
|
"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": 334,
|
|
"name": "getBucket",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 48,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 335,
|
|
"name": "getBucket",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Retrieves the details of an existing Storage bucket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 336,
|
|
"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": 337,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 338,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 52,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 395,
|
|
"name": "Bucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 339,
|
|
"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": [
|
|
338,
|
|
339
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 340,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 341,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 56,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 342,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 57,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
341,
|
|
342
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 35,
|
|
"name": "default.getBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 34,
|
|
"name": "default.getBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 326,
|
|
"name": "listBuckets",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 21,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 327,
|
|
"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": 328,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 329,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 23,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 395,
|
|
"name": "Bucket"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 330,
|
|
"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": [
|
|
329,
|
|
330
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 331,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 332,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 27,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 333,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 28,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
332,
|
|
333
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 27,
|
|
"name": "default.listBuckets"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 26,
|
|
"name": "default.listBuckets"
|
|
}
|
|
},
|
|
{
|
|
"id": 357,
|
|
"name": "updateBucket",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 139,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 358,
|
|
"name": "updateBucket",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updates a Storage bucket"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 359,
|
|
"name": "id",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "A unique identifier for the bucket you are updating."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 360,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 361,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 364,
|
|
"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": 363,
|
|
"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": 362,
|
|
"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": [
|
|
364,
|
|
363,
|
|
362
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"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/packages/StorageBucketApi.ts",
|
|
"line": 148,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 367,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 368,
|
|
"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": [
|
|
368
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 369,
|
|
"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": [
|
|
366,
|
|
369
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 370,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 371,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 152,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 372,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageBucketApi.ts",
|
|
"line": 153,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
371,
|
|
372
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"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": [
|
|
301
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
343,
|
|
384,
|
|
373,
|
|
313,
|
|
334,
|
|
326,
|
|
357
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/StorageClient.ts",
|
|
"line": 5,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 3,
|
|
"name": "default"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 440,
|
|
"name": "StorageError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 441,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 4,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 442,
|
|
"name": "new StorageError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 443,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
441
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 1,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Error",
|
|
"package": "typescript",
|
|
"name": "Error"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 445,
|
|
"name": "StorageApiError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 458,
|
|
"name": "StorageUnknownError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 458,
|
|
"name": "StorageUnknownError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 459,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 35,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 460,
|
|
"name": "new StorageUnknownError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 461,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 462,
|
|
"name": "originalError",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 458,
|
|
"name": "StorageUnknownError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 442,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 441,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 463,
|
|
"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": [
|
|
459
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
463
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 32,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "Bucket",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 400,
|
|
"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": 401,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 7,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 399,
|
|
"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": 396,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 2,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 397,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 3,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 398,
|
|
"name": "owner",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 4,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 403,
|
|
"name": "public",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 9,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 402,
|
|
"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": [
|
|
400,
|
|
401,
|
|
399,
|
|
396,
|
|
397,
|
|
398,
|
|
403,
|
|
402
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 427,
|
|
"name": "FetchParameters",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 428,
|
|
"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": [
|
|
428
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 70,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 404,
|
|
"name": "FileObject",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 406,
|
|
"name": "bucket_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 14,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "buckets",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 21,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 395,
|
|
"name": "Bucket",
|
|
"dereferenced": {
|
|
"id": 395,
|
|
"name": "Bucket",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 400,
|
|
"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": 401,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 7,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 399,
|
|
"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": 396,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 2,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 397,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 3,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 398,
|
|
"name": "owner",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 4,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 403,
|
|
"name": "public",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 9,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 402,
|
|
"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": [
|
|
400,
|
|
401,
|
|
399,
|
|
396,
|
|
397,
|
|
398,
|
|
403,
|
|
402
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 410,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 18,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 16,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 411,
|
|
"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": 412,
|
|
"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": 405,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 13,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 407,
|
|
"name": "owner",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 15,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 409,
|
|
"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": [
|
|
406,
|
|
413,
|
|
410,
|
|
408,
|
|
411,
|
|
412,
|
|
405,
|
|
407,
|
|
409
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 12,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "FileOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 418,
|
|
"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=<seconds>` header. Defaults to 3600 seconds."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 33,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 419,
|
|
"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": 421,
|
|
"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": 420,
|
|
"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": [
|
|
418,
|
|
419,
|
|
421,
|
|
420
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 29,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "Metadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 430,
|
|
"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": [
|
|
430
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 78,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "SearchOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 423,
|
|
"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": 424,
|
|
"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": 426,
|
|
"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": 425,
|
|
"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": 414,
|
|
"name": "SortBy",
|
|
"dereferenced": {
|
|
"id": 414,
|
|
"name": "SortBy",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 415,
|
|
"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": 416,
|
|
"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": [
|
|
415,
|
|
416
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 24,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
423,
|
|
424,
|
|
426,
|
|
425
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 48,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 414,
|
|
"name": "SortBy",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 415,
|
|
"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": 416,
|
|
"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": [
|
|
415,
|
|
416
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 24,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 431,
|
|
"name": "TransformOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 436,
|
|
"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": 433,
|
|
"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": 435,
|
|
"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": 434,
|
|
"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": 432,
|
|
"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": [
|
|
436,
|
|
433,
|
|
435,
|
|
434,
|
|
432
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 82,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 437,
|
|
"name": "isStorageError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 10,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 438,
|
|
"name": "isStorageError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 439,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"kind": 128,
|
|
"children": [
|
|
445,
|
|
300,
|
|
440,
|
|
458
|
|
]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"kind": 256,
|
|
"children": [
|
|
395,
|
|
427,
|
|
404,
|
|
417,
|
|
429,
|
|
422,
|
|
414,
|
|
431
|
|
]
|
|
},
|
|
{
|
|
"title": "Functions",
|
|
"kind": 64,
|
|
"children": [
|
|
437
|
|
]
|
|
}
|
|
],
|
|
"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": 395,
|
|
"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": 440,
|
|
"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": 440,
|
|
"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": 440,
|
|
"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": 395,
|
|
"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": 440,
|
|
"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": 395,
|
|
"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": 440,
|
|
"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": 440,
|
|
"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": 300,
|
|
"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": 203,
|
|
"name": "copy",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 338,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 204,
|
|
"name": "copy",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Copies an existing file to a new path in the same bucket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 205,
|
|
"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": 206,
|
|
"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": 207,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 208,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 343,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 209,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 210,
|
|
"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": [
|
|
210
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 211,
|
|
"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": [
|
|
208,
|
|
211
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 212,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 213,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 347,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 214,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 348,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
213,
|
|
214
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 165,
|
|
"name": "createSignedUploadUrl",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 223,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 166,
|
|
"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": 167,
|
|
"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": 168,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 169,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 227,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 170,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 173,
|
|
"name": "path",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 227,
|
|
"character": 50
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 171,
|
|
"name": "signedUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 227,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 172,
|
|
"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": [
|
|
173,
|
|
171,
|
|
172
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 174,
|
|
"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": [
|
|
169,
|
|
174
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 175,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 176,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 231,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 177,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 232,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
176,
|
|
177
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 215,
|
|
"name": "createSignedUrl",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 376,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 216,
|
|
"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": 217,
|
|
"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": 218,
|
|
"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": 219,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 220,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 221,
|
|
"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": 222,
|
|
"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": 431,
|
|
"name": "TransformOptions",
|
|
"dereferenced": {
|
|
"id": 431,
|
|
"name": "TransformOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 436,
|
|
"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": 433,
|
|
"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": 435,
|
|
"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": 434,
|
|
"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": 432,
|
|
"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": [
|
|
436,
|
|
433,
|
|
435,
|
|
434,
|
|
432
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 82,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
221,
|
|
222
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 223,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 224,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 382,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 225,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 226,
|
|
"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": [
|
|
226
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 227,
|
|
"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": [
|
|
224,
|
|
227
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 228,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 229,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 386,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 230,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 387,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
229,
|
|
230
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 231,
|
|
"name": "createSignedUrls",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 421,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 232,
|
|
"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": 233,
|
|
"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": 234,
|
|
"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": 235,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 236,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 237,
|
|
"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": [
|
|
237
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 238,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 239,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 427,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 240,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 241,
|
|
"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": 242,
|
|
"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": 243,
|
|
"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": [
|
|
241,
|
|
242,
|
|
243
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 244,
|
|
"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": [
|
|
239,
|
|
244
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 245,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 246,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 431,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 247,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 432,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
246,
|
|
247
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 248,
|
|
"name": "download",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 470,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 249,
|
|
"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": 250,
|
|
"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": 251,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 252,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 253,
|
|
"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": 431,
|
|
"name": "TransformOptions",
|
|
"dereferenced": {
|
|
"id": 431,
|
|
"name": "TransformOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 436,
|
|
"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": 433,
|
|
"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": 435,
|
|
"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": 434,
|
|
"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": 432,
|
|
"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": [
|
|
436,
|
|
433,
|
|
435,
|
|
434,
|
|
432
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 82,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
253
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 254,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 255,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 475,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Blob",
|
|
"package": "typescript",
|
|
"name": "Blob"
|
|
}
|
|
},
|
|
{
|
|
"id": 256,
|
|
"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": [
|
|
255,
|
|
256
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 257,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 258,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 479,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 259,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 480,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
258,
|
|
259
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 260,
|
|
"name": "getPublicUrl",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 513,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 261,
|
|
"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": 262,
|
|
"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": 263,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 264,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 265,
|
|
"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": 266,
|
|
"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": 431,
|
|
"name": "TransformOptions",
|
|
"dereferenced": {
|
|
"id": 431,
|
|
"name": "TransformOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 436,
|
|
"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": 433,
|
|
"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": 435,
|
|
"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": 434,
|
|
"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": 432,
|
|
"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": [
|
|
436,
|
|
433,
|
|
435,
|
|
434,
|
|
432
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 82,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
265,
|
|
266
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 267,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 268,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 516,
|
|
"character": 7
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 269,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 270,
|
|
"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": [
|
|
270
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
268
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 280,
|
|
"name": "list",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 647,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 281,
|
|
"name": "list",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Lists all the files within a bucket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 282,
|
|
"name": "path",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The folder path.\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 283,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 422,
|
|
"name": "SearchOptions",
|
|
"dereferenced": {
|
|
"id": 422,
|
|
"name": "SearchOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 423,
|
|
"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": 424,
|
|
"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": 426,
|
|
"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": 425,
|
|
"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": 414,
|
|
"name": "SortBy",
|
|
"dereferenced": {
|
|
"id": 414,
|
|
"name": "SortBy",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 415,
|
|
"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": 416,
|
|
"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": [
|
|
415,
|
|
416
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 24,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
423,
|
|
424,
|
|
426,
|
|
425
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 48,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 284,
|
|
"name": "parameters",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 427,
|
|
"name": "FetchParameters",
|
|
"dereferenced": {
|
|
"id": 427,
|
|
"name": "FetchParameters",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 428,
|
|
"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": [
|
|
428
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 70,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 285,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 286,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 653,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 404,
|
|
"name": "FileObject"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 287,
|
|
"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": [
|
|
286,
|
|
287
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 288,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 289,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 657,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 290,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 658,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
289,
|
|
290
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 191,
|
|
"name": "move",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 302,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 192,
|
|
"name": "move",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Moves an existing file to a new path in the same bucket."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 193,
|
|
"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": 194,
|
|
"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": 195,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 196,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 307,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 197,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 198,
|
|
"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": [
|
|
198
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 199,
|
|
"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": [
|
|
196,
|
|
199
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 200,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 201,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 311,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 202,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 312,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
201,
|
|
202
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 271,
|
|
"name": "remove",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 551,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 272,
|
|
"name": "remove",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Deletes files within the same bucket"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 273,
|
|
"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": 274,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 275,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 555,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 404,
|
|
"name": "FileObject"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 276,
|
|
"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": [
|
|
275,
|
|
276
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 277,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 278,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 559,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 279,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 560,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
278,
|
|
279
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 178,
|
|
"name": "update",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 269,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 179,
|
|
"name": "update",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Replaces an existing file at the specified path with a new one."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 180,
|
|
"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": 181,
|
|
"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": 182,
|
|
"name": "fileOptions",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 417,
|
|
"name": "FileOptions",
|
|
"dereferenced": {
|
|
"id": 417,
|
|
"name": "FileOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 418,
|
|
"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=<seconds>` header. Defaults to 3600 seconds."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 33,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 419,
|
|
"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": 421,
|
|
"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": 420,
|
|
"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": [
|
|
418,
|
|
419,
|
|
421,
|
|
420
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 29,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 183,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 184,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 285,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 185,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 186,
|
|
"name": "path",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 285,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
186
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 187,
|
|
"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": [
|
|
184,
|
|
187
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 188,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 189,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 289,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 190,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 290,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
189,
|
|
190
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"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": 417,
|
|
"name": "FileOptions",
|
|
"dereferenced": {
|
|
"id": 417,
|
|
"name": "FileOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 418,
|
|
"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=<seconds>` header. Defaults to 3600 seconds."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 33,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 419,
|
|
"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": 421,
|
|
"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": 420,
|
|
"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": [
|
|
418,
|
|
419,
|
|
421,
|
|
420
|
|
]
|
|
}
|
|
],
|
|
"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": 145,
|
|
"name": "path",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 141,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
145
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 146,
|
|
"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,
|
|
146
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 147,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 148,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 145,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 149,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 146,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 440,
|
|
"name": "StorageError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
148,
|
|
149
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 150,
|
|
"name": "uploadToSignedUrl",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 158,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 151,
|
|
"name": "uploadToSignedUrl",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Upload a file with a token generated from `createSignedUploadUrl`."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 152,
|
|
"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": 153,
|
|
"name": "token",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The token generated from `createSignedUploadUrl`"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 154,
|
|
"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": 155,
|
|
"name": "fileOptions",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 417,
|
|
"name": "FileOptions",
|
|
"dereferenced": {
|
|
"id": 417,
|
|
"name": "FileOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 418,
|
|
"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=<seconds>` header. Defaults to 3600 seconds."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 33,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 419,
|
|
"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": 421,
|
|
"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": 420,
|
|
"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": [
|
|
418,
|
|
419,
|
|
421,
|
|
420
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 29,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 156,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 157,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/packages/StorageFileApi.ts",
|
|
"line": 201,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 158,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 160,
|
|
"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": 159,
|
|
"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": [
|
|
160,
|
|
159
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 161,
|
|
"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": [
|
|
157,
|
|
161
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 162,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 163,
|
|
"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": 164,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
163,
|
|
164
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
97
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
203,
|
|
165,
|
|
215,
|
|
231,
|
|
248,
|
|
260,
|
|
280,
|
|
191,
|
|
271,
|
|
178,
|
|
137,
|
|
150
|
|
]
|
|
}
|
|
],
|
|
"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": 1,
|
|
"name": "FunctionsClient",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 2,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/FunctionsClient.ts",
|
|
"line": 16,
|
|
"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": 23,
|
|
"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": 22,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
8,
|
|
7
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1,
|
|
"name": "FunctionsClient"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/FunctionsClient.ts",
|
|
"line": 14,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 16,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 17,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 18,
|
|
"name": "input",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInfo",
|
|
"package": "typescript",
|
|
"name": "RequestInfo"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 19,
|
|
"name": "init",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInit",
|
|
"package": "typescript",
|
|
"name": "RequestInit"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Response",
|
|
"package": "typescript",
|
|
"name": "Response"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 14,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/FunctionsClient.ts",
|
|
"line": 13,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"qualifiedName": "Record",
|
|
"package": "typescript",
|
|
"name": "Record"
|
|
}
|
|
},
|
|
{
|
|
"id": 13,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/FunctionsClient.ts",
|
|
"line": 12,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 23,
|
|
"name": "invoke",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/FunctionsClient.ts",
|
|
"line": 44,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 24,
|
|
"name": "invoke",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Invokes a function"
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 25,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 26,
|
|
"name": "functionName",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The name of the Function to invoke."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 27,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Options for invoking the Function.\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 28,
|
|
"name": "FunctionInvokeOptions",
|
|
"dereferenced": {
|
|
"id": 28,
|
|
"name": "FunctionInvokeOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 44,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 29,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 35,
|
|
"name": "body",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The body of the request."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 56,
|
|
"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": 30,
|
|
"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": 48,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 31,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 48,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 32,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 33,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 34,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The HTTP verb of the request"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 52,
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
35,
|
|
30,
|
|
34
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 44,
|
|
"character": 36
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 58,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 25,
|
|
"name": "T"
|
|
}
|
|
],
|
|
"name": "FunctionsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 20,
|
|
"name": "setAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/FunctionsClient.ts",
|
|
"line": 35,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 21,
|
|
"name": "setAuth",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updates the authorization header"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 22,
|
|
"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": [
|
|
15,
|
|
14,
|
|
13
|
|
]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
23,
|
|
20
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/FunctionsClient.ts",
|
|
"line": 11,
|
|
"character": 13
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 36,
|
|
"name": "FunctionsError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 37,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 19,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 38,
|
|
"name": "new FunctionsError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 39,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 40,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "'FunctionsError'"
|
|
},
|
|
{
|
|
"id": 41,
|
|
"name": "context",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 36,
|
|
"name": "FunctionsError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 42,
|
|
"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": [
|
|
37
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
42
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 17,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Error",
|
|
"package": "typescript",
|
|
"name": "Error"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 43,
|
|
"name": "FunctionsFetchError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 48,
|
|
"name": "FunctionsHttpError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 53,
|
|
"name": "FunctionsRelayError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 43,
|
|
"name": "FunctionsFetchError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 44,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 27,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 45,
|
|
"name": "new FunctionsFetchError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 46,
|
|
"name": "context",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 43,
|
|
"name": "FunctionsFetchError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 38,
|
|
"name": "FunctionsError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 37,
|
|
"name": "FunctionsError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 47,
|
|
"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": 42,
|
|
"name": "FunctionsError.context"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
44
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
47
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 26,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 36,
|
|
"name": "FunctionsError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 48,
|
|
"name": "FunctionsHttpError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 49,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 39,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 50,
|
|
"name": "new FunctionsHttpError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 51,
|
|
"name": "context",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 48,
|
|
"name": "FunctionsHttpError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 38,
|
|
"name": "FunctionsError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 37,
|
|
"name": "FunctionsError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 52,
|
|
"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": 42,
|
|
"name": "FunctionsError.context"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
49
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
52
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 38,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 36,
|
|
"name": "FunctionsError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 53,
|
|
"name": "FunctionsRelayError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 54,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 33,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 55,
|
|
"name": "new FunctionsRelayError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 56,
|
|
"name": "context",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 53,
|
|
"name": "FunctionsRelayError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 38,
|
|
"name": "FunctionsError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 37,
|
|
"name": "FunctionsError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 57,
|
|
"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": 42,
|
|
"name": "FunctionsError.context"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [
|
|
54
|
|
]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
57
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 32,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 36,
|
|
"name": "FunctionsError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 28,
|
|
"name": "FunctionInvokeOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 44,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 29,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 35,
|
|
"name": "body",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The body of the request."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 56,
|
|
"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": 30,
|
|
"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": 48,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 31,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 48,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 32,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 33,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 34,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The HTTP verb of the request"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 52,
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
35,
|
|
30,
|
|
34
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 44,
|
|
"character": 36
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 58,
|
|
"name": "FunctionsResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/types.ts",
|
|
"line": 15,
|
|
"character": 12
|
|
}
|
|
],
|
|
"typeParameter": [
|
|
{
|
|
"id": 59,
|
|
"name": "T",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
null,
|
|
null
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"kind": 128,
|
|
"children": [
|
|
1,
|
|
36,
|
|
43,
|
|
48,
|
|
53
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"kind": 4194304,
|
|
"children": [
|
|
28,
|
|
58
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 1,
|
|
"character": 0
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|