Files
supabase/apps/docs/spec/enrichments/tsdoc_v2/realtime.json
2024-01-03 18:54:23 +01:00

7059 lines
146 KiB
JSON

{
"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"
},
"defaultValue": "..."
},
{
"id": 79,
"name": "socket",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 359,
"name": "default"
}
}
],
"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"
},
"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"
}
},
{
"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"
}
},
{
"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"
}
},
{
"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"
}
},
{
"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"
}
},
{
"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"
}
},
{
"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"
}
}
],
"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"
},
"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"
}
}
],
"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"
}
}
],
"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"
}
},
{
"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"
}
},
{
"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"
},
"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"
}
},
{
"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": [
{
"type": "reference",
"id": 517,
"typeArguments": [
{
"type": "reference",
"id": 516,
"name": "T"
}
],
"name": "RealtimePostgresInsertPayload"
},
{
"type": "reference",
"id": 527,
"typeArguments": [
{
"type": "reference",
"id": 516,
"name": "T"
}
],
"name": "RealtimePostgresUpdatePayload"
},
{
"type": "reference",
"id": 536,
"typeArguments": [
{
"type": "reference",
"id": 516,
"name": "T"
}
],
"name": "RealtimePostgresDeletePayload"
}
]
}
},
{
"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
}
]
}