Files
supabase/apps/docs/spec/enrichments/tsdoc_v2/realtime.json
T
supabase-supabase-autofixer[bot]andsupabase-releaser[bot] d71717585e docs: update js sdk docs (2.105.4) (#45718)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.105.4`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2026-05-08 18:01:36 +03:00

17436 lines
627 KiB
JSON

{
"id": 0,
"name": "@supabase/realtime-js",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 693,
"name": "REALTIME_LISTEN_TYPES",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 694,
"name": "BROADCAST",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 138,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L138"
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 696,
"name": "POSTGRES_CHANGES",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 140,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L140"
}
],
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 695,
"name": "PRESENCE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 139,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L139"
}
],
"type": {
"type": "literal",
"value": "presence"
}
},
{
"id": 697,
"name": "SYSTEM",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 141,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L141"
}
],
"type": {
"type": "literal",
"value": "system"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [694, 696, 695, 697]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 137,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L137"
}
]
},
{
"id": 698,
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 699,
"name": "ALL",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 131,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L131"
}
],
"type": {
"type": "literal",
"value": "*"
}
},
{
"id": 702,
"name": "DELETE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 134,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L134"
}
],
"type": {
"type": "literal",
"value": "DELETE"
}
},
{
"id": 700,
"name": "INSERT",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 132,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L132"
}
],
"type": {
"type": "literal",
"value": "INSERT"
}
},
{
"id": 701,
"name": "UPDATE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 133,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L133"
}
],
"type": {
"type": "literal",
"value": "UPDATE"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [699, 702, 700, 701]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 130,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L130"
}
]
},
{
"id": 703,
"name": "REALTIME_PRESENCE_LISTEN_EVENTS",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 705,
"name": "JOIN",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 33,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L33"
}
],
"type": {
"type": "literal",
"value": "join"
}
},
{
"id": 706,
"name": "LEAVE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 34,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L34"
}
],
"type": {
"type": "literal",
"value": "leave"
}
},
{
"id": 704,
"name": "SYNC",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 32,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L32"
}
],
"type": {
"type": "literal",
"value": "sync"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [705, 706, 704]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 31,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L31"
}
]
},
{
"id": 707,
"name": "REALTIME_SUBSCRIBE_STATES",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 711,
"name": "CHANNEL_ERROR",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 148,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L148"
}
],
"type": {
"type": "literal",
"value": "CHANNEL_ERROR"
}
},
{
"id": 710,
"name": "CLOSED",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 147,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L147"
}
],
"type": {
"type": "literal",
"value": "CLOSED"
}
},
{
"id": 708,
"name": "SUBSCRIBED",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 145,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L145"
}
],
"type": {
"type": "literal",
"value": "SUBSCRIBED"
}
},
{
"id": 709,
"name": "TIMED_OUT",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 146,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L146"
}
],
"type": {
"type": "literal",
"value": "TIMED_OUT"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [711, 710, 708, 709]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 144,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L144"
}
]
},
{
"id": 10,
"name": "RealtimeChannel",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "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": 15,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 238,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L238"
}
],
"signatures": [
{
"id": 16,
"name": "RealtimeChannel",
"variant": "signature",
"kind": 16384,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\n\nThe topic determines which realtime stream you are subscribing to. Config options let you\nenable acknowledgement for broadcasts, presence tracking, or private channels."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
},
{
"tag": "@example",
"name": "Using supabase-js (recommended)",
"content": [
{
"kind": "code",
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```"
}
]
},
{
"tag": "@example",
"name": "Standalone import for bundle-sensitive environments",
"content": [
{
"kind": "code",
"text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 238,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L238"
}
],
"parameters": [
{
"id": 17,
"name": "topic",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Topic name can be any string."
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 18,
"name": "params",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 380,
"name": "RealtimeChannelOptions",
"package": "@supabase/realtime-js"
},
"defaultValue": "..."
},
{
"id": 19,
"name": "socket",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 396,
"name": "RealtimeClient",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 20,
"name": "bindings",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 177,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L177"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "Binding"
},
"name": "Binding",
"package": "@supabase/realtime-js"
}
}
],
"name": "Record",
"package": "typescript"
},
"defaultValue": "{}"
},
{
"id": 22,
"name": "broadcastEndpointURL",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 179,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L179"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 39,
"name": "params",
"variant": "declaration",
"kind": 1024,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 241,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L241"
}
],
"type": {
"type": "reference",
"target": 380,
"name": "RealtimeChannelOptions",
"package": "@supabase/realtime-js"
},
"defaultValue": "..."
},
{
"id": 24,
"name": "presence",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 181,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L181"
}
],
"type": {
"type": "reference",
"target": 1,
"name": "RealtimePresence",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 23,
"name": "private",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 180,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L180"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 40,
"name": "socket",
"variant": "declaration",
"kind": 1024,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 242,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L242"
}
],
"type": {
"type": "reference",
"target": 396,
"name": "RealtimeClient",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 21,
"name": "subTopic",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 178,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L178"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 38,
"name": "topic",
"variant": "declaration",
"kind": 1024,
"flags": {
"isPublic": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Topic name can be any string."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 240,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L240"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 30,
"name": "joinedOnce",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 193,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L193"
}
],
"getSignature": {
"id": 31,
"name": "joinedOnce",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 193,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L193"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
},
{
"id": 34,
"name": "joinPush",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 201,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L201"
}
],
"getSignature": {
"id": 35,
"name": "joinPush",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 201,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L201"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/push.js",
"qualifiedName": "default"
},
"name": "Push",
"package": "@supabase/phoenix",
"qualifiedName": "default"
}
}
},
{
"id": 36,
"name": "rejoinTimer",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 205,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L205"
}
],
"getSignature": {
"id": 37,
"name": "rejoinTimer",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 205,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L205"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/timer.js",
"qualifiedName": "default"
},
"name": "Timer",
"package": "@supabase/phoenix",
"qualifiedName": "default"
}
}
},
{
"id": 26,
"name": "state",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 185,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L185"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 189,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L189"
}
],
"getSignature": {
"id": 27,
"name": "state",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 185,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L185"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "ChannelState"
},
"name": "ChannelState",
"package": "@supabase/phoenix"
}
},
"setSignature": {
"id": 28,
"name": "state",
"variant": "signature",
"kind": 1048576,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 189,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L189"
}
],
"parameters": [
{
"id": 29,
"name": "state",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "ChannelState"
},
"name": "ChannelState",
"package": "@supabase/phoenix"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
},
{
"id": 32,
"name": "timeout",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 197,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L197"
}
],
"getSignature": {
"id": 33,
"name": "timeout",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 197,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L197"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
},
{
"id": 369,
"name": "copyBindings",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 1076,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L1076"
}
],
"signatures": [
{
"id": 370,
"name": "copyBindings",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 1076,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L1076"
}
],
"parameters": [
{
"id": 371,
"name": "other",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 305,
"name": "httpSend",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 746,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L746"
}
],
"signatures": [
{
"id": 306,
"name": "httpSend",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sends a broadcast message explicitly via REST API.\n\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback."
}
],
"blockTags": [
{
"tag": "@returns",
"content": [
{
"kind": "text",
"text": "Promise resolving to object with success status, and error details if failed"
}
]
},
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 746,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L746"
}
],
"parameters": [
{
"id": 307,
"name": "event",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The name of the broadcast event"
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 308,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Payload to be sent (required)"
}
]
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 309,
"name": "opts",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Options including timeout"
}
]
},
"type": {
"type": "reflection",
"declaration": {
"id": 310,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 311,
"name": "timeout",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 749,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L749"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"children": [311]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 749,
"character": 10,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L749"
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 312,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 313,
"name": "success",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 750,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L750"
}
],
"type": {
"type": "literal",
"value": true
}
}
],
"groups": [
{
"title": "Properties",
"children": [313]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 750,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L750"
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 314,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 317,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 750,
"character": 67,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L750"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 316,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 750,
"character": 51,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L750"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 315,
"name": "success",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 750,
"character": 35,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L750"
}
],
"type": {
"type": "literal",
"value": false
}
}
],
"groups": [
{
"title": "Properties",
"children": [317, 316, 315]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 750,
"character": 33,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L750"
}
]
}
}
]
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 86,
"name": "on",
"variant": "declaration",
"kind": 2048,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Listen to realtime events on this channel."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
},
{
"tag": "@remarks",
"content": [
{
"kind": "text",
"text": "- By default, Broadcast and Presence are enabled for all projects.\n- By default, listening to database changes is disabled for new projects due to database performance and security concerns. You can turn it on by managing Realtime's [replication](/docs/guides/api#realtime-api-overview).\n- You can receive the \"previous\" data for updates and deletes by setting the table's "
},
{
"kind": "code",
"text": "`REPLICA IDENTITY`"
},
{
"kind": "text",
"text": " to "
},
{
"kind": "code",
"text": "`FULL`"
},
{
"kind": "text",
"text": " (e.g., "
},
{
"kind": "code",
"text": "`ALTER TABLE your_table REPLICA IDENTITY FULL;`"
},
{
"kind": "text",
"text": ").\n- Row level security is not applied to delete statements. When RLS is enabled and replica identity is set to full, only the primary key is sent to clients."
}
]
},
{
"tag": "@example",
"name": "Listen to broadcast messages",
"content": [
{
"kind": "code",
"text": "```js\nconst channel = supabase.channel(\"room1\")\n\nchannel.on(\"broadcast\", { event: \"cursor-pos\" }, (payload) => {\n console.log(\"Cursor position received!\", payload);\n}).subscribe((status) => {\n if (status === \"SUBSCRIBED\") {\n channel.send({\n type: \"broadcast\",\n event: \"cursor-pos\",\n payload: { x: Math.random(), y: Math.random() },\n });\n }\n});\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to presence sync",
"content": [
{
"kind": "code",
"text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'sync' }, () => {\n console.log('Synced presence state: ', channel.presenceState())\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to presence join",
"content": [
{
"kind": "code",
"text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('Newly joined presences: ', newPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to presence leave",
"content": [
{
"kind": "code",
"text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Newly left presences: ', leftPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n await channel.untrack()\n }\n })\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to all database changes",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: '*' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to a specific table",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to inserts",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```"
}
]
},
{
"tag": "@exampleDescription",
"content": [
{
"kind": "text",
"text": "Listen to updates\nBy default, Supabase will send only the updated record. If you want to receive the previous values as well you can\nenable full replication for the table you are listening to:\n\n"
},
{
"kind": "code",
"text": "```sql\nalter table \"your_table\" replica identity full;\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to updates",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```"
}
]
},
{
"tag": "@exampleDescription",
"content": [
{
"kind": "text",
"text": "Listen to deletes\nBy default, Supabase does not send deleted records. If you want to receive the deleted record you can\nenable full replication for the table you are listening to:\n\n"
},
{
"kind": "code",
"text": "```sql\nalter table \"your_table\" replica identity full;\n```"
}
]
},
{
"tag": "@example",
"name": "Listen to deletes",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```"
}
]
},
{
"tag": "@exampleDescription",
"content": [
{
"kind": "text",
"text": "Listen to multiple events\nYou can chain listeners if you want to listen to multiple events for each table."
}
]
},
{
"tag": "@example",
"name": "Listen to multiple events",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, handleRecordInserted)\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, handleRecordDeleted)\n .subscribe()\n```"
}
]
},
{
"tag": "@exampleDescription",
"content": [
{
"kind": "text",
"text": "Listen to row level changes\nYou can listen to individual rows using the format "
},
{
"kind": "code",
"text": "`{table}:{col}=eq.{val}`"
},
{
"kind": "text",
"text": " - where "
},
{
"kind": "code",
"text": "`{col}`"
},
{
"kind": "text",
"text": " is the column name, and "
},
{
"kind": "code",
"text": "`{val}`"
},
{
"kind": "text",
"text": " is the value which you want to match."
}
]
},
{
"tag": "@example",
"name": "Listen to row level changes",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries', filter: 'id=eq.200' }, handleRecordUpdated)\n .subscribe()\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 438,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L438"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 443,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L443"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 448,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L448"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 453,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L453"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 458,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L458"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 463,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L463"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 468,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L468"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 473,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L473"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 478,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L478"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 489,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L489"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 502,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L502"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 515,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L515"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 524,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L524"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 533,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L533"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 542,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L542"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 551,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L551"
},
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 715,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L715"
}
],
"signatures": [
{
"id": 87,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 438,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L438"
}
],
"parameters": [
{
"id": 88,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "presence"
}
},
{
"id": 89,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 90,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 91,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 440,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L440"
}
],
"type": {
"type": "literal",
"value": "sync"
}
}
],
"groups": [
{
"title": "Properties",
"children": [91]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 440,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L440"
}
]
}
}
},
{
"id": 92,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 93,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 441,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L441"
}
],
"signatures": [
{
"id": 94,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 441,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L441"
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 95,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 443,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L443"
}
],
"typeParameters": [
{
"id": 96,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 97,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 443,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L443"
}
],
"indexSignatures": [
{
"id": 98,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 443,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L443"
}
],
"parameters": [
{
"id": 99,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 100,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "presence"
}
},
{
"id": 101,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 102,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 103,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 445,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L445"
}
],
"type": {
"type": "literal",
"value": "join"
}
}
],
"groups": [
{
"title": "Properties",
"children": [103]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 445,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L445"
}
]
}
}
},
{
"id": 104,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 105,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 446,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L446"
}
],
"signatures": [
{
"id": 106,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 446,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L446"
}
],
"parameters": [
{
"id": 107,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 662,
"typeArguments": [
{
"type": "reference",
"target": 96,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePresenceJoinPayload",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 108,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 448,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L448"
}
],
"typeParameters": [
{
"id": 109,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 110,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 448,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L448"
}
],
"indexSignatures": [
{
"id": 111,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 448,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L448"
}
],
"parameters": [
{
"id": 112,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 113,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "presence"
}
},
{
"id": 114,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 115,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 116,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 450,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L450"
}
],
"type": {
"type": "literal",
"value": "leave"
}
}
],
"groups": [
{
"title": "Properties",
"children": [116]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 450,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L450"
}
]
}
}
},
{
"id": 117,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 118,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 451,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L451"
}
],
"signatures": [
{
"id": 119,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 451,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L451"
}
],
"parameters": [
{
"id": 120,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 672,
"typeArguments": [
{
"type": "reference",
"target": 109,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePresenceLeavePayload",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 121,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 453,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L453"
}
],
"typeParameters": [
{
"id": 122,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 123,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 453,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L453"
}
],
"indexSignatures": [
{
"id": 124,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 453,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L453"
}
],
"parameters": [
{
"id": 125,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 126,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "presence"
}
},
{
"id": 127,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 128,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 129,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 455,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L455"
}
],
"type": {
"type": "literal",
"value": "*"
}
}
],
"groups": [
{
"title": "Properties",
"children": [129]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 455,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L455"
}
]
}
}
},
{
"id": 130,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 131,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 456,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L456"
}
],
"signatures": [
{
"id": 132,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 456,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L456"
}
],
"parameters": [
{
"id": 133,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"target": 662,
"typeArguments": [
{
"type": "reference",
"target": 122,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePresenceJoinPayload",
"package": "@supabase/realtime-js"
},
{
"type": "reference",
"target": 672,
"typeArguments": [
{
"type": "reference",
"target": 122,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePresenceLeavePayload",
"package": "@supabase/realtime-js"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 134,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 458,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L458"
}
],
"typeParameters": [
{
"id": 135,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 136,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 458,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L458"
}
],
"indexSignatures": [
{
"id": 137,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 458,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L458"
}
],
"parameters": [
{
"id": 138,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 139,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 140,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 621,
"typeArguments": [
{
"type": "literal",
"value": "*"
}
],
"name": "RealtimePostgresChangesFilter",
"package": "@supabase/realtime-js"
}
},
{
"id": 141,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 142,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 461,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L461"
}
],
"signatures": [
{
"id": 143,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 461,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L461"
}
],
"parameters": [
{
"id": 144,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 628,
"typeArguments": [
{
"type": "reference",
"target": 135,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresChangesPayload",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 145,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 463,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L463"
}
],
"typeParameters": [
{
"id": 146,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 147,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 463,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L463"
}
],
"indexSignatures": [
{
"id": 148,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 463,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L463"
}
],
"parameters": [
{
"id": 149,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 150,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 151,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 621,
"typeArguments": [
{
"type": "literal",
"value": "INSERT"
}
],
"name": "RealtimePostgresChangesFilter",
"package": "@supabase/realtime-js"
}
},
{
"id": 152,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 153,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 466,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L466"
}
],
"signatures": [
{
"id": 154,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 466,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L466"
}
],
"parameters": [
{
"id": 155,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 633,
"typeArguments": [
{
"type": "reference",
"target": 146,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresInsertPayload",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 156,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 468,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L468"
}
],
"typeParameters": [
{
"id": 157,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 158,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 468,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L468"
}
],
"indexSignatures": [
{
"id": 159,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 468,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L468"
}
],
"parameters": [
{
"id": 160,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 161,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 162,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 621,
"typeArguments": [
{
"type": "literal",
"value": "UPDATE"
}
],
"name": "RealtimePostgresChangesFilter",
"package": "@supabase/realtime-js"
}
},
{
"id": 163,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 164,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 471,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L471"
}
],
"signatures": [
{
"id": 165,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 471,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L471"
}
],
"parameters": [
{
"id": 166,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 643,
"typeArguments": [
{
"type": "reference",
"target": 157,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresUpdatePayload",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 167,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 473,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L473"
}
],
"typeParameters": [
{
"id": 168,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 169,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 473,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L473"
}
],
"indexSignatures": [
{
"id": 170,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 473,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L473"
}
],
"parameters": [
{
"id": 171,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 172,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 173,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 621,
"typeArguments": [
{
"type": "literal",
"value": "DELETE"
}
],
"name": "RealtimePostgresChangesFilter",
"package": "@supabase/realtime-js"
}
},
{
"id": 174,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 175,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 476,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L476"
}
],
"signatures": [
{
"id": 176,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 476,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L476"
}
],
"parameters": [
{
"id": 177,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 652,
"typeArguments": [
{
"type": "reference",
"target": 168,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresDeletePayload",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 178,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 478,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L478"
}
],
"typeParameters": [
{
"id": 179,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 180,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 478,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L478"
}
],
"indexSignatures": [
{
"id": 181,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 478,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L478"
}
],
"parameters": [
{
"id": 182,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 183,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 184,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 621,
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": "INSERT"
},
{
"type": "literal",
"value": "UPDATE"
},
{
"type": "literal",
"value": "DELETE"
},
{
"type": "literal",
"value": "*"
}
]
}
],
"name": "RealtimePostgresChangesFilter",
"package": "@supabase/realtime-js"
}
},
{
"id": 185,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 186,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 481,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L481"
}
],
"signatures": [
{
"id": 187,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 481,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L481"
}
],
"parameters": [
{
"id": 188,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 628,
"typeArguments": [
{
"type": "reference",
"target": 179,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresChangesPayload",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 189,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 489,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L489"
}
],
"parameters": [
{
"id": 190,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "One of \"broadcast\", \"presence\", or \"postgres_changes\"."
}
]
},
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 191,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Custom object specific to the Realtime feature detailing which payloads to receive."
}
]
},
"type": {
"type": "reflection",
"declaration": {
"id": 192,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 193,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 491,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L491"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [193]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 491,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L491"
}
]
}
}
},
{
"id": 194,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Function to be invoked when event handler is triggered."
}
]
},
"type": {
"type": "reflection",
"declaration": {
"id": 195,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 492,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L492"
}
],
"signatures": [
{
"id": 196,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 492,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L492"
}
],
"parameters": [
{
"id": 197,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 198,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 200,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 494,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L494"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 201,
"name": "meta",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 495,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L495"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 202,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 204,
"name": "id",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 497,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L497"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 203,
"name": "replayed",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 496,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L496"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"children": [204, 203]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 495,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L495"
}
]
}
}
},
{
"id": 199,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 493,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L493"
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
}
],
"groups": [
{
"title": "Properties",
"children": [200, 201, 199]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 492,
"character": 24,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L492"
}
],
"indexSignatures": [
{
"id": 205,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 499,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L499"
}
],
"parameters": [
{
"id": 206,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 207,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 502,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L502"
}
],
"typeParameters": [
{
"id": 208,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 209,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 502,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L502"
}
],
"indexSignatures": [
{
"id": 210,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 502,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L502"
}
],
"parameters": [
{
"id": 211,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 212,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 213,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 214,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 215,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 504,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L504"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [215]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 504,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L504"
}
]
}
}
},
{
"id": 216,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 217,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 505,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L505"
}
],
"signatures": [
{
"id": 218,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 505,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L505"
}
],
"parameters": [
{
"id": 219,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 220,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 222,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 507,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L507"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 223,
"name": "meta",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 508,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L508"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 224,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 226,
"name": "id",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 510,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L510"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 225,
"name": "replayed",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 509,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L509"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"children": [226, 225]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 508,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L508"
}
]
}
}
},
{
"id": 227,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 512,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L512"
}
],
"type": {
"type": "reference",
"target": 208,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
},
{
"id": 221,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 506,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L506"
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
}
],
"groups": [
{
"title": "Properties",
"children": [222, 223, 227, 221]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 505,
"character": 24,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L505"
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 228,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 515,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L515"
}
],
"typeParameters": [
{
"id": 229,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
}
],
"parameters": [
{
"id": 230,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 231,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 232,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 233,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 517,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L517"
}
],
"type": {
"type": "reference",
"target": 699,
"name": "ALL",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL"
}
}
],
"groups": [
{
"title": "Properties",
"children": [233]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 517,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L517"
}
]
}
}
},
{
"id": 234,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 235,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 518,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L518"
}
],
"signatures": [
{
"id": 236,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 518,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L518"
}
],
"parameters": [
{
"id": 237,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 238,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 240,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 520,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L520"
}
],
"type": {
"type": "reference",
"target": 699,
"name": "ALL",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL"
}
},
{
"id": 241,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 521,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L521"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimeBroadcastPayload"
},
"typeArguments": [
{
"type": "reference",
"target": 229,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimeBroadcastPayload",
"package": "@supabase/realtime-js"
}
},
{
"id": 239,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 519,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L519"
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
}
],
"groups": [
{
"title": "Properties",
"children": [240, 241, 239]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 518,
"character": 24,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L518"
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 242,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 524,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L524"
}
],
"typeParameters": [
{
"id": 243,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 244,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 524,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L524"
}
],
"indexSignatures": [
{
"id": 245,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 524,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L524"
}
],
"parameters": [
{
"id": 246,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 247,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 248,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 249,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 250,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 526,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L526"
}
],
"type": {
"type": "reference",
"target": 700,
"name": "INSERT",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT"
}
}
],
"groups": [
{
"title": "Properties",
"children": [250]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 526,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L526"
}
]
}
}
},
{
"id": 251,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 252,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 527,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L527"
}
],
"signatures": [
{
"id": 253,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 527,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L527"
}
],
"parameters": [
{
"id": 254,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 255,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 257,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 529,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L529"
}
],
"type": {
"type": "reference",
"target": 700,
"name": "INSERT",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT"
}
},
{
"id": 258,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 530,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L530"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimeBroadcastInsertPayload"
},
"typeArguments": [
{
"type": "reference",
"target": 243,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimeBroadcastInsertPayload",
"package": "@supabase/realtime-js"
}
},
{
"id": 256,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 528,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L528"
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
}
],
"groups": [
{
"title": "Properties",
"children": [257, 258, 256]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 527,
"character": 24,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L527"
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 259,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 533,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L533"
}
],
"typeParameters": [
{
"id": 260,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 261,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 533,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L533"
}
],
"indexSignatures": [
{
"id": 262,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 533,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L533"
}
],
"parameters": [
{
"id": 263,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 264,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 265,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 266,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 267,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 535,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L535"
}
],
"type": {
"type": "reference",
"target": 701,
"name": "UPDATE",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE"
}
}
],
"groups": [
{
"title": "Properties",
"children": [267]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 535,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L535"
}
]
}
}
},
{
"id": 268,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 269,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 536,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L536"
}
],
"signatures": [
{
"id": 270,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 536,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L536"
}
],
"parameters": [
{
"id": 271,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 272,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 274,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 538,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L538"
}
],
"type": {
"type": "reference",
"target": 701,
"name": "UPDATE",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE"
}
},
{
"id": 275,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 539,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L539"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimeBroadcastUpdatePayload"
},
"typeArguments": [
{
"type": "reference",
"target": 260,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimeBroadcastUpdatePayload",
"package": "@supabase/realtime-js"
}
},
{
"id": 273,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 537,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L537"
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
}
],
"groups": [
{
"title": "Properties",
"children": [274, 275, 273]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 536,
"character": 24,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L536"
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 276,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 542,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L542"
}
],
"typeParameters": [
{
"id": 277,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 278,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 542,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L542"
}
],
"indexSignatures": [
{
"id": 279,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 542,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L542"
}
],
"parameters": [
{
"id": 280,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 281,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 282,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 283,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 284,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 544,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L544"
}
],
"type": {
"type": "reference",
"target": 702,
"name": "DELETE",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE"
}
}
],
"groups": [
{
"title": "Properties",
"children": [284]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 544,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L544"
}
]
}
}
},
{
"id": 285,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 286,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 545,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L545"
}
],
"signatures": [
{
"id": 287,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 545,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L545"
}
],
"parameters": [
{
"id": 288,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 289,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 291,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 547,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L547"
}
],
"type": {
"type": "reference",
"target": 702,
"name": "DELETE",
"package": "@supabase/realtime-js",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE"
}
},
{
"id": 292,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 548,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L548"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimeBroadcastDeletePayload"
},
"typeArguments": [
{
"type": "reference",
"target": 277,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimeBroadcastDeletePayload",
"package": "@supabase/realtime-js"
}
},
{
"id": 290,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 546,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L546"
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
}
],
"groups": [
{
"title": "Properties",
"children": [291, 292, 290]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 545,
"character": 24,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L545"
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 293,
"name": "on",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an event handler that listens to changes."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 551,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L551"
}
],
"typeParameters": [
{
"id": 294,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 295,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 551,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L551"
}
],
"indexSignatures": [
{
"id": 296,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 551,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L551"
}
],
"parameters": [
{
"id": 297,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"parameters": [
{
"id": 298,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "literal",
"value": "system"
}
},
{
"id": 299,
"name": "filter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 300,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
},
{
"id": 301,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 302,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 554,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L554"
}
],
"signatures": [
{
"id": 303,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 554,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L554"
}
],
"parameters": [
{
"id": 304,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 63,
"name": "presenceState",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 396,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L396"
}
],
"signatures": [
{
"id": 64,
"name": "presenceState",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns the current presence state for this channel.\n\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\ntracked metadata for that user."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 396,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L396"
}
],
"typeParameters": [
{
"id": 65,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 66,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 396,
"character": 26,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L396"
}
],
"indexSignatures": [
{
"id": 67,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 396,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L396"
}
],
"parameters": [
{
"id": 68,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
},
"default": {
"type": "reflection",
"declaration": {
"id": 69,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
}
],
"type": {
"type": "reference",
"target": 682,
"typeArguments": [
{
"type": "reference",
"target": 65,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePresenceState",
"package": "@supabase/realtime-js"
}
}
]
},
{
"id": 318,
"name": "send",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 840,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L840"
}
],
"signatures": [
{
"id": 319,
"name": "send",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sends a message into the channel."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
},
{
"tag": "@remarks",
"content": [
{
"kind": "text",
"text": "- When using REST you don't need to subscribe to the channel\n- REST calls are only available from 2.37.0 onwards"
}
]
},
{
"tag": "@example",
"name": "Send a message via websocket",
"content": [
{
"kind": "code",
"text": "```js\nconst channel = supabase.channel('room1')\n\nchannel.subscribe((status) => {\n if (status === 'SUBSCRIBED') {\n channel.send({\n type: 'broadcast',\n event: 'cursor-pos',\n payload: { x: Math.random(), y: Math.random() },\n })\n }\n})\n```"
}
]
},
{
"tag": "@exampleResponse",
"content": [
{
"kind": "text",
"text": "Send a message via websocket\n"
},
{
"kind": "code",
"text": "```js\nok | timed out | error\n```"
}
]
},
{
"tag": "@example",
"name": "Send a message via REST",
"content": [
{
"kind": "code",
"text": "```js\nsupabase\n .channel('room1')\n .httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 840,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L840"
}
],
"parameters": [
{
"id": 320,
"name": "args",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Arguments to send to channel"
}
]
},
"type": {
"type": "reflection",
"declaration": {
"id": 321,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 323,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The name of the event being sent"
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 843,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L843"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 324,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Payload to be sent"
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 844,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L844"
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 322,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The type of event to send"
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 842,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L842"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "broadcast"
},
{
"type": "literal",
"value": "presence"
},
{
"type": "literal",
"value": "postgres_changes"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [323, 324, 322]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 841,
"character": 10,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L841"
}
],
"indexSignatures": [
{
"id": 325,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 845,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L845"
}
],
"parameters": [
{
"id": 326,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
},
{
"id": 327,
"name": "opts",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Options to be used during the send process"
}
]
},
"type": {
"type": "reflection",
"declaration": {
"id": 328,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 847,
"character": 10,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L847"
}
],
"indexSignatures": [
{
"id": 329,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 847,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L847"
}
],
"parameters": [
{
"id": 330,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": 394,
"name": "RealtimeChannelSendResponse",
"package": "@supabase/realtime-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 41,
"name": "subscribe",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 277,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L277"
}
],
"signatures": [
{
"id": 42,
"name": "subscribe",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Subscribe registers your client with the server"
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 277,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L277"
}
],
"parameters": [
{
"id": 43,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 44,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 278,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L278"
}
],
"signatures": [
{
"id": 45,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 278,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L278"
}
],
"parameters": [
{
"id": 46,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 707,
"name": "REALTIME_SUBSCRIBE_STATES",
"package": "@supabase/realtime-js"
}
},
{
"id": 47,
"name": "err",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Error"
},
"name": "Error",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
},
{
"id": 48,
"name": "timeout",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 337,
"name": "teardown",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 948,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L948"
}
],
"signatures": [
{
"id": 338,
"name": "teardown",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Destroys and stops related timers."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 948,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L948"
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 70,
"name": "track",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 406,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L406"
}
],
"signatures": [
{
"id": 71,
"name": "track",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sends the supplied payload to the presence tracker so other subscribers can see that this\nclient is online. Use "
},
{
"kind": "code",
"text": "`untrack`"
},
{
"kind": "text",
"text": " to stop broadcasting presence for the same key."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 406,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L406"
}
],
"parameters": [
{
"id": 72,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 73,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 407,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L407"
}
],
"indexSignatures": [
{
"id": 74,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 407,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L407"
}
],
"parameters": [
{
"id": 75,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
},
{
"id": 76,
"name": "opts",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 77,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 408,
"character": 10,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L408"
}
],
"indexSignatures": [
{
"id": 78,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 408,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L408"
}
],
"parameters": [
{
"id": 79,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": 394,
"name": "RealtimeChannelSendResponse",
"package": "@supabase/realtime-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 334,
"name": "unsubscribe",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 933,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L933"
}
],
"signatures": [
{
"id": 335,
"name": "unsubscribe",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Leaves the channel.\n\nUnsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a "
},
{
"kind": "code",
"text": "`receive`"
},
{
"kind": "text",
"text": " hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )"
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 933,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L933"
}
],
"parameters": [
{
"id": 336,
"name": "timeout",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": 394,
"name": "RealtimeChannelSendResponse",
"package": "@supabase/realtime-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 80,
"name": "untrack",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 425,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L425"
}
],
"signatures": [
{
"id": 81,
"name": "untrack",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Removes the current presence state for this client."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 425,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L425"
}
],
"parameters": [
{
"id": 82,
"name": "opts",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 83,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 425,
"character": 22,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L425"
}
],
"indexSignatures": [
{
"id": 84,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 425,
"character": 24,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L425"
}
],
"parameters": [
{
"id": 85,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": 394,
"name": "RealtimeChannelSendResponse",
"package": "@supabase/realtime-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 331,
"name": "updateJoinPayload",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 918,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L918"
}
],
"signatures": [
{
"id": 332,
"name": "updateJoinPayload",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Updates the payload that will be sent the next time the channel joins (reconnects).\nUseful for rotating access tokens or updating config without re-creating the channel."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 918,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L918"
}
],
"parameters": [
{
"id": 333,
"name": "payload",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Record",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [15]
},
{
"title": "Properties",
"children": [20, 22, 39, 24, 23, 40, 21, 38]
},
{
"title": "Accessors",
"children": [30, 34, 36, 26, 32]
},
{
"title": "Methods",
"children": [369, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331]
}
],
"categories": [
{
"title": "Other",
"children": [20, 22, 39, 24, 23, 40, 21, 38, 30, 34, 36, 26, 32, 369]
},
{
"title": "Realtime",
"children": [15, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 176,
"character": 21,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L176"
}
]
},
{
"id": 396,
"name": "RealtimeClient",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 397,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 277,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L277"
}
],
"signatures": [
{
"id": 398,
"name": "RealtimeClient",
"variant": "signature",
"kind": 16384,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Initializes the Socket."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
},
{
"tag": "@example",
"name": "Using supabase-js (recommended)",
"content": [
{
"kind": "code",
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```"
}
]
},
{
"tag": "@example",
"name": "Standalone import for bundle-sensitive environments",
"content": [
{
"kind": "code",
"text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nclient.connect()\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 277,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L277"
}
],
"parameters": [
{
"id": 399,
"name": "endPoint",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)"
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 400,
"name": "options",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": 573,
"name": "RealtimeClientOptions",
"package": "@supabase/realtime-js",
"highlightedProperties": {
"transport": [
{
"kind": "text",
"text": "The Websocket Transport, for example WebSocket. This can be a custom implementation"
}
],
"timeout": [
{
"kind": "text",
"text": "The default timeout in milliseconds to trigger push timeouts."
}
],
"params": [
{
"kind": "text",
"text": "The optional params to pass when connecting."
}
],
"headers": [
{
"kind": "text",
"text": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future."
}
],
"heartbeatIntervalMs": [
{
"kind": "text",
"text": "The millisec interval to send a heartbeat message."
}
],
"heartbeatCallback": [
{
"kind": "text",
"text": "The optional function to handle heartbeat status and latency."
}
],
"logger": [
{
"kind": "text",
"text": "The optional function for specialized logging, ie: logger: (kind, msg, data) => { console.log("
},
{
"kind": "code",
"text": "`${kind}: ${msg}`"
},
{
"kind": "text",
"text": ", data) }"
}
],
"logLevel": [
{
"kind": "text",
"text": "Sets the log level for Realtime"
}
],
"encode": [
{
"kind": "text",
"text": "The function to encode outgoing messages. Defaults to JSON: (payload, callback) => callback(JSON.stringify(payload))"
}
],
"decode": [
{
"kind": "text",
"text": "The function to decode incoming messages. Defaults to Serializer's decode."
}
],
"reconnectAfterMs": [
{
"kind": "text",
"text": "he optional function that returns the millsec reconnect interval. Defaults to stepped backoff off."
}
],
"worker": [
{
"kind": "text",
"text": "Use Web Worker to set a side flow. Defaults to false."
}
],
"workerUrl": [
{
"kind": "text",
"text": "The URL of the worker script. Defaults to https://realtime.supabase.com/worker.js that includes a heartbeat event call to keep the connection alive."
}
],
"vsn": [
{
"kind": "text",
"text": "The protocol version to use when connecting. Supported versions are \"1.0.0\" and \"2.0.0\". Defaults to \"2.0.0\"."
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 396,
"name": "RealtimeClient",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 404,
"name": "accessToken",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 141,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L141"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 405,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 141,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L141"
}
],
"signatures": [
{
"id": 406,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 141,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L141"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
],
"name": "Promise",
"package": "typescript"
}
}
]
}
}
]
},
"defaultValue": "null"
},
{
"id": 403,
"name": "accessTokenValue",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 140,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L140"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "null"
},
{
"id": 407,
"name": "apiKey",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 142,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L142"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "null"
},
{
"id": 402,
"name": "channels",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 138,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L138"
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
"defaultValue": "..."
},
{
"id": 419,
"name": "fetch",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 153,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L153"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 420,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 29329,
"character": 17
},
{
"fileName": "node_modules/@types/node/globals.d.ts",
"line": 289,
"character": 13
}
],
"signatures": [
{
"id": 421,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
}
]
},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 29329,
"character": 17
}
],
"parameters": [
{
"id": 422,
"name": "input",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInfo"
},
"name": "RequestInfo",
"package": "typescript"
}
]
}
},
{
"id": 423,
"name": "init",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInit"
},
"name": "RequestInit",
"package": "typescript"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Response"
},
"name": "Response",
"package": "typescript"
}
],
"name": "Promise",
"package": "typescript"
}
},
{
"id": 424,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
}
]
},
"sources": [
{
"fileName": "node_modules/@types/node/globals.d.ts",
"line": 289,
"character": 13
}
],
"parameters": [
{
"id": 425,
"name": "input",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Request"
},
"name": "Request",
"package": "typescript"
}
]
}
},
{
"id": 426,
"name": "init",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInit"
},
"name": "RequestInit",
"package": "typescript"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Response"
},
"name": "Response",
"package": "typescript"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
}
}
},
{
"id": 409,
"name": "headers",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [],
"blockTags": [
{
"tag": "@deprecated",
"content": [
{
"kind": "text",
"text": "headers cannot be set on websocket connections"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 146,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L146"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 410,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 146,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L146"
}
],
"indexSignatures": [
{
"id": 411,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 146,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L146"
}
],
"parameters": [
{
"id": 412,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
},
"defaultValue": "{}"
},
{
"id": 408,
"name": "httpEndpoint",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 144,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L144"
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "''"
},
{
"id": 418,
"name": "logLevel",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 151,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L151"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "LogLevel"
},
"name": "LogLevel",
"package": "@supabase/realtime-js"
}
},
{
"id": 413,
"name": "params",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 147,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L147"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 414,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 147,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L147"
}
],
"indexSignatures": [
{
"id": 415,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 147,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L147"
}
],
"parameters": [
{
"id": 416,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
},
"defaultValue": "{}"
},
{
"id": 417,
"name": "ref",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 149,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L149"
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 430,
"name": "serializer",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 158,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L158"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/lib/serializer.ts",
"qualifiedName": "default"
},
"name": "Serializer",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
},
"defaultValue": "..."
},
{
"id": 427,
"name": "worker",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 154,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L154"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 429,
"name": "workerRef",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 156,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L156"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Worker"
},
"name": "Worker",
"package": "typescript"
}
},
{
"id": 428,
"name": "workerUrl",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 155,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L155"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 451,
"name": "decode",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 206,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L206"
}
],
"getSignature": {
"id": 452,
"name": "decode",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 206,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L206"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "Decode"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Decode",
"package": "@supabase/phoenix"
}
}
},
{
"id": 449,
"name": "encode",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 202,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L202"
}
],
"getSignature": {
"id": 450,
"name": "encode",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 202,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L202"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "Encode"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Encode",
"package": "@supabase/phoenix"
}
}
},
{
"id": 431,
"name": "endPoint",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 160,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L160"
}
],
"getSignature": {
"id": 432,
"name": "endPoint",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 160,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L160"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
},
{
"id": 437,
"name": "heartbeatCallback",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 172,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L172"
}
],
"getSignature": {
"id": 438,
"name": "heartbeatCallback",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 172,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L172"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "HeartbeatCallback"
},
"name": "HeartbeatCallback",
"package": "@supabase/phoenix"
}
}
},
{
"id": 439,
"name": "heartbeatIntervalMs",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 176,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L176"
}
],
"getSignature": {
"id": 440,
"name": "heartbeatIntervalMs",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 176,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L176"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
},
{
"id": 441,
"name": "heartbeatTimer",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 180,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L180"
}
],
"getSignature": {
"id": 442,
"name": "heartbeatTimer",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 180,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L180"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "HeartbeatTimer"
},
"name": "HeartbeatTimer",
"package": "@supabase/realtime-js"
}
}
},
{
"id": 443,
"name": "pendingHeartbeatRef",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 187,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L187"
}
],
"getSignature": {
"id": 444,
"name": "pendingHeartbeatRef",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 187,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L187"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
},
{
"id": 453,
"name": "reconnectAfterMs",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 210,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L210"
}
],
"getSignature": {
"id": 454,
"name": "reconnectAfterMs",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 210,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L210"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 455,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts",
"line": 74,
"character": 26,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74"
}
],
"signatures": [
{
"id": 456,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts",
"line": 74,
"character": 26,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74"
}
],
"parameters": [
{
"id": 457,
"name": "tries",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
]
}
}
}
},
{
"id": 445,
"name": "reconnectTimer",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 194,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L194"
}
],
"getSignature": {
"id": 446,
"name": "reconnectTimer",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 194,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L194"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/timer.js",
"qualifiedName": "default"
},
"name": "Timer",
"package": "@supabase/phoenix",
"qualifiedName": "default"
}
}
},
{
"id": 458,
"name": "sendBuffer",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 214,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L214"
}
],
"getSignature": {
"id": 459,
"name": "sendBuffer",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 214,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L214"
}
],
"type": {
"type": "array",
"elementType": {
"type": "reflection",
"declaration": {
"id": 460,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts",
"line": 78,
"character": 21,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78"
}
],
"signatures": [
{
"id": 461,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts",
"line": 78,
"character": 21,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78"
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
}
},
{
"id": 462,
"name": "stateChangeCallbacks",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 218,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L218"
}
],
"getSignature": {
"id": 463,
"name": "stateChangeCallbacks",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 218,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L218"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 464,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 466,
"name": "close",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 220,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L220"
}
],
"type": {
"type": "array",
"elementType": {
"type": "tuple",
"elements": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Function"
},
"name": "Function",
"package": "typescript"
}
]
}
}
},
{
"id": 467,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 221,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L221"
}
],
"type": {
"type": "array",
"elementType": {
"type": "tuple",
"elements": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Function"
},
"name": "Function",
"package": "typescript"
}
]
}
}
},
{
"id": 468,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 222,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L222"
}
],
"type": {
"type": "array",
"elementType": {
"type": "tuple",
"elements": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Function"
},
"name": "Function",
"package": "typescript"
}
]
}
}
},
{
"id": 465,
"name": "open",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 219,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L219"
}
],
"type": {
"type": "array",
"elementType": {
"type": "tuple",
"elements": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Function"
},
"name": "Function",
"package": "typescript"
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"children": [466, 467, 468, 465]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 218,
"character": 30,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L218"
}
]
}
}
}
},
{
"id": 433,
"name": "timeout",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 164,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L164"
}
],
"getSignature": {
"id": 434,
"name": "timeout",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 164,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L164"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
},
{
"id": 435,
"name": "transport",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 168,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L168"
}
],
"getSignature": {
"id": 436,
"name": "transport",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 168,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L168"
}
],
"type": {
"type": "reference",
"target": 782,
"name": "WebSocketLikeConstructor",
"package": "@supabase/realtime-js"
}
}
},
{
"id": 447,
"name": "vsn",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 198,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L198"
}
],
"getSignature": {
"id": 448,
"name": "vsn",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 198,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L198"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "Vsn"
},
"name": "Vsn",
"package": "@supabase/phoenix"
}
}
},
{
"id": 503,
"name": "channel",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 469,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L469"
}
],
"signatures": [
{
"id": 504,
"name": "channel",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates (or reuses) a "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "RealtimeChannel",
"target": 10
},
{
"kind": "text",
"text": " for the provided topic.\n\nTopics are automatically prefixed with "
},
{
"kind": "code",
"text": "`realtime:`"
},
{
"kind": "text",
"text": " to match the Realtime service.\nIf a channel with the same topic already exists it will be returned instead of creating\na duplicate connection."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 469,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L469"
}
],
"parameters": [
{
"id": 505,
"name": "topic",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 506,
"name": "params",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 380,
"name": "RealtimeChannelOptions",
"package": "@supabase/realtime-js"
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 475,
"name": "connect",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 297,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L297"
}
],
"signatures": [
{
"id": 476,
"name": "connect",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Connects the socket, unless already connected."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 297,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L297"
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 495,
"name": "connectionState",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 429,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L429"
}
],
"signatures": [
{
"id": 496,
"name": "connectionState",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns the current state of the socket."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 429,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L429"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/lib/constants.ts",
"qualifiedName": "ConnectionState"
},
"name": "ConnectionState",
"package": "@supabase/realtime-js"
}
}
]
},
{
"id": 479,
"name": "disconnect",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 356,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L356"
}
],
"signatures": [
{
"id": 480,
"name": "disconnect",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Disconnects the socket."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 356,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L356"
}
],
"parameters": [
{
"id": 481,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "A numeric status code to send on disconnect."
}
]
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 482,
"name": "reason",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "A custom reason for the disconnect."
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "timeout"
}
]
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 477,
"name": "endpointURL",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 344,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L344"
}
],
"signatures": [
{
"id": 478,
"name": "endpointURL",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns the URL of the websocket."
}
],
"blockTags": [
{
"tag": "@returns",
"content": [
{
"kind": "text",
"text": "string The URL of the websocket."
}
]
},
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 344,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L344"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 483,
"name": "getChannels",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 376,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L376"
}
],
"signatures": [
{
"id": 484,
"name": "getChannels",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns all created channels"
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 376,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L376"
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
}
]
},
{
"id": 497,
"name": "isConnected",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 438,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L438"
}
],
"signatures": [
{
"id": 498,
"name": "isConnected",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": " is the connection is open."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 438,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L438"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 499,
"name": "isConnecting",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 447,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L447"
}
],
"signatures": [
{
"id": 500,
"name": "isConnecting",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": " if the connection is currently connecting."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 447,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L447"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 501,
"name": "isDisconnecting",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 456,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L456"
}
],
"signatures": [
{
"id": 502,
"name": "isDisconnecting",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": " if the connection is currently disconnecting."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 456,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L456"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 490,
"name": "log",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 420,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L420"
}
],
"signatures": [
{
"id": 491,
"name": "log",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Logs the message.\n\nFor customized logging, "
},
{
"kind": "code",
"text": "`this.logger`"
},
{
"kind": "text",
"text": " can be overridden in Client constructor."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 420,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L420"
}
],
"parameters": [
{
"id": 492,
"name": "kind",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 493,
"name": "msg",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 494,
"name": "data",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 517,
"name": "onHeartbeat",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 550,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L550"
}
],
"signatures": [
{
"id": 518,
"name": "onHeartbeat",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sets a callback that receives lifecycle events for internal heartbeat messages.\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 550,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L550"
}
],
"parameters": [
{
"id": 519,
"name": "callback",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "HeartbeatCallback"
},
"name": "HeartbeatCallback",
"package": "@supabase/phoenix"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 507,
"name": "push",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 491,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L491"
}
],
"signatures": [
{
"id": 508,
"name": "push",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Push out a message if the socket is connected.\n\nIf the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 491,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L491"
}
],
"parameters": [
{
"id": 509,
"name": "data",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 614,
"name": "RealtimeMessage",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 488,
"name": "removeAllChannels",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 401,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L401"
}
],
"signatures": [
{
"id": 489,
"name": "removeAllChannels",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Unsubscribes, removes and tears down all channels"
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 401,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L401"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "array",
"elementType": {
"type": "reference",
"target": 691,
"name": "RealtimeRemoveChannelResponse",
"package": "@supabase/realtime-js"
}
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 485,
"name": "removeChannel",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 386,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L386"
}
],
"signatures": [
{
"id": 486,
"name": "removeChannel",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Unsubscribes, removes and tears down a single channel"
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 386,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L386"
}
],
"parameters": [
{
"id": 487,
"name": "channel",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "A RealtimeChannel instance"
}
]
},
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": 691,
"name": "RealtimeRemoveChannelResponse",
"package": "@supabase/realtime-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 515,
"name": "sendHeartbeat",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 540,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L540"
}
],
"signatures": [
{
"id": 516,
"name": "sendHeartbeat",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sends a heartbeat message if the socket is connected."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 540,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L540"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 510,
"name": "setAuth",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 517,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L517"
}
],
"signatures": [
{
"id": 511,
"name": "setAuth",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.\n\nIf param is null it will use the "
},
{
"kind": "code",
"text": "`accessToken`"
},
{
"kind": "text",
"text": " callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n\nWhen a token is explicitly provided, it will be preserved across channel operations\n(including removeChannel and resubscribe). The "
},
{
"kind": "code",
"text": "`accessToken`"
},
{
"kind": "text",
"text": " callback will not be\ninvoked until "
},
{
"kind": "code",
"text": "`setAuth()`"
},
{
"kind": "text",
"text": " is called without arguments."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nSetting the authorization header\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\nclient.realtime.setAuth('my-custom-jwt')\n\n// Switch back to using the accessToken callback\nclient.realtime.setAuth()\n```"
}
]
},
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 517,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L517"
}
],
"parameters": [
{
"id": 512,
"name": "token",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "A JWT string to override the token set on the client."
}
]
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "null"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [397]
},
{
"title": "Properties",
"children": [404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428]
},
{
"title": "Accessors",
"children": [451, 449, 431, 437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447]
},
{
"title": "Methods",
"children": [
503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510
]
}
],
"categories": [
{
"title": "Other",
"children": [
404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428, 451, 449, 431,
437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447
]
},
{
"title": "Realtime",
"children": [
397, 503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510
]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 135,
"character": 21,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L135"
}
]
},
{
"id": 1,
"name": "RealtimePresence",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 2,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 65,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L65"
}
],
"signatures": [
{
"id": 3,
"name": "RealtimePresence",
"variant": "signature",
"kind": 16384,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates a Presence helper that keeps the local presence state in sync with the server."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
},
{
"tag": "@example",
"name": "Example for a presence channel",
"content": [
{
"kind": "code",
"text": "```ts\nconst presence = new RealtimePresence(channel)\n\nchannel.on('presence', ({ event, key }) => {\n console.log(`Presence ${event} on ${key}`)\n})\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 65,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L65"
}
],
"parameters": [
{
"id": 4,
"name": "channel",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The realtime channel to bind to."
}
]
},
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 5,
"name": "opts",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Optional custom event names, e.g. "
},
{
"kind": "code",
"text": "`{ events: { state: 'state', diff: 'diff' } }`"
},
{
"kind": "text",
"text": "."
}
]
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "RealtimePresenceOptions"
},
"name": "RealtimePresenceOptions",
"package": "@supabase/realtime-js"
}
}
],
"type": {
"type": "reference",
"target": 1,
"name": "RealtimePresence",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 9,
"name": "channel",
"variant": "declaration",
"kind": 1024,
"flags": {
"isPublic": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The realtime channel to bind to."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 66,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L66"
}
],
"type": {
"type": "reference",
"target": 10,
"name": "RealtimeChannel",
"package": "@supabase/realtime-js",
"qualifiedName": "default"
}
},
{
"id": 6,
"name": "state",
"variant": "declaration",
"kind": 262144,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 42,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L42"
}
],
"getSignature": {
"id": 7,
"name": "state",
"variant": "signature",
"kind": 524288,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 42,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L42"
}
],
"type": {
"type": "reference",
"target": 682,
"name": "RealtimePresenceState",
"package": "@supabase/realtime-js"
}
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2]
},
{
"title": "Properties",
"children": [9]
},
{
"title": "Accessors",
"children": [6]
}
],
"categories": [
{
"title": "Other",
"children": [9, 6]
},
{
"title": "Realtime",
"children": [2]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 41,
"character": 21,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L41"
}
]
},
{
"id": 719,
"name": "WebSocketFactory",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Utilities for creating WebSocket instances across runtimes."
}
]
},
"children": [
{
"id": 722,
"name": "getWebSocketConstructor",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true,
"isStatic": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 169,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L169"
}
],
"signatures": [
{
"id": 723,
"name": "getWebSocketConstructor",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Returns the best available WebSocket constructor for the current runtime."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
},
{
"tag": "@example",
"name": "Example with error handling",
"content": [
{
"kind": "code",
"text": "```ts\ntry {\n const WS = WebSocketFactory.getWebSocketConstructor()\n const socket = new WS('wss://example.com/socket')\n} catch (error) {\n console.error('WebSocket not available in this environment.', error)\n}\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 169,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L169"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 724,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 26772,
"character": 23
}
],
"signatures": [
{
"id": 725,
"name": "getWebSocketConstructor",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 26774,
"character": 4
}
],
"parameters": [
{
"id": 726,
"name": "url",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
}
]
}
},
{
"id": 727,
"name": "protocols",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "WebSocket"
},
"name": "WebSocket",
"package": "typescript"
}
}
]
}
}
}
]
},
{
"id": 728,
"name": "isWebSocketSupported",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true,
"isStatic": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 194,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L194"
}
],
"signatures": [
{
"id": 729,
"name": "isWebSocketSupported",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Detects whether the runtime can establish WebSocket connections."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Realtime"
}
]
},
{
"tag": "@example",
"name": "Example in a Node.js script",
"content": [
{
"kind": "code",
"text": "```ts\nif (!WebSocketFactory.isWebSocketSupported()) {\n console.error('WebSockets are required for this script.')\n process.exitCode = 1\n}\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 194,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L194"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
}
],
"groups": [
{
"title": "Methods",
"children": [722, 728]
}
],
"categories": [
{
"title": "Realtime",
"children": [722, 728]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 61,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L61"
}
]
},
{
"id": 732,
"name": "WebSocketLike",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
"id": 775,
"name": "binaryType",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 34,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L34"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 776,
"name": "bufferedAmount",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 35,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L35"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 736,
"name": "CLOSED",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 5,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L5"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 735,
"name": "CLOSING",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 4,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L4"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 733,
"name": "CONNECTING",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 2,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L2"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 778,
"name": "dispatchEvent",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 37,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L37"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 779,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 37,
"character": 18,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L37"
}
],
"signatures": [
{
"id": 780,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 37,
"character": 18,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L37"
}
],
"parameters": [
{
"id": 781,
"name": "event",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Event"
},
"name": "Event",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
}
}
},
{
"id": 777,
"name": "extensions",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 36,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L36"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 757,
"name": "onclose",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 21,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L21"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 758,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 21,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L21"
}
],
"signatures": [
{
"id": 759,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 21,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L21"
}
],
"parameters": [
{
"id": 760,
"name": "this",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 761,
"name": "ev",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "CloseEvent"
},
"name": "CloseEvent",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
]
}
},
{
"id": 762,
"name": "onerror",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 22,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L22"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 763,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 22,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L22"
}
],
"signatures": [
{
"id": 764,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 22,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L22"
}
],
"parameters": [
{
"id": 765,
"name": "this",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 766,
"name": "ev",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Event"
},
"name": "Event",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
]
}
},
{
"id": 752,
"name": "onmessage",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 20,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L20"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 753,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 20,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L20"
}
],
"signatures": [
{
"id": 754,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 20,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L20"
}
],
"parameters": [
{
"id": 755,
"name": "this",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 756,
"name": "ev",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "MessageEvent"
},
"name": "MessageEvent",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
]
}
},
{
"id": 747,
"name": "onopen",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 19,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L19"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 748,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 19,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L19"
}
],
"signatures": [
{
"id": 749,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 19,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L19"
}
],
"parameters": [
{
"id": 750,
"name": "this",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 751,
"name": "ev",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Event"
},
"name": "Event",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
]
}
},
{
"id": 734,
"name": "OPEN",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 3,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L3"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 739,
"name": "protocol",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 8,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L8"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 737,
"name": "readyState",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 6,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L6"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 738,
"name": "url",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 7,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L7"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 767,
"name": "addEventListener",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 27,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L27"
}
],
"signatures": [
{
"id": 768,
"name": "addEventListener",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Registers an event listener on the socket (compatible with browser WebSocket API)."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 27,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L27"
}
],
"parameters": [
{
"id": 769,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 770,
"name": "listener",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "EventListener"
},
"name": "EventListener",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 740,
"name": "close",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 13,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L13"
}
],
"signatures": [
{
"id": 741,
"name": "close",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Closes the socket, optionally providing a close code and reason."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 13,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L13"
}
],
"parameters": [
{
"id": 742,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 743,
"name": "reason",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 771,
"name": "removeEventListener",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L31"
}
],
"signatures": [
{
"id": 772,
"name": "removeEventListener",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Removes a previously registered event listener."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L31"
}
],
"parameters": [
{
"id": 773,
"name": "type",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 774,
"name": "listener",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "EventListener"
},
"name": "EventListener",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 744,
"name": "send",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 17,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L17"
}
],
"signatures": [
{
"id": 745,
"name": "send",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Sends data through the socket using the underlying implementation."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 17,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L17"
}
],
"parameters": [
{
"id": 746,
"name": "data",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "ArrayBufferLike"
},
"name": "ArrayBufferLike",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Blob"
},
"name": "Blob",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "ArrayBufferView"
},
"typeArguments": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "ArrayBufferLike"
},
"name": "ArrayBufferLike",
"package": "typescript"
}
],
"name": "ArrayBufferView",
"package": "typescript"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Properties",
"children": [775, 776, 736, 735, 733, 778, 777, 757, 762, 752, 747, 734, 739, 737, 738]
},
{
"title": "Methods",
"children": [767, 740, 771, 744]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts",
"line": 1,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/websocket-factory.ts#L1"
}
]
},
{
"id": 782,
"name": "WebSocketLikeConstructor",
"variant": "declaration",
"kind": 256,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Minimal WebSocket constructor interface that RealtimeClient can work with.\nSupply a compatible implementation (native WebSocket, "
},
{
"kind": "code",
"text": "`ws`"
},
{
"kind": "text",
"text": ", etc) when running outside the browser."
}
]
},
"children": [
{
"id": 783,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 58,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L58"
}
],
"signatures": [
{
"id": 784,
"name": "WebSocketLikeConstructor",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 59,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L59"
}
],
"parameters": [
{
"id": 785,
"name": "address",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
}
]
}
},
{
"id": 786,
"name": "subprotocols",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
],
"type": {
"type": "reference",
"target": 732,
"name": "WebSocketLike",
"package": "@supabase/realtime-js"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [783]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 58,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L58"
}
],
"indexSignatures": [
{
"id": 787,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 61,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L61"
}
],
"parameters": [
{
"id": 788,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
},
{
"id": 380,
"name": "RealtimeChannelOptions",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 22,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L22"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 381,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 382,
"name": "config",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 23,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L23"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 383,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 384,
"name": "broadcast",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received\nreplay option instructs server to replay broadcast messages"
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 29,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L29"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 385,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 387,
"name": "ack",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 29,
"character": 34,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L29"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 388,
"name": "replay",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 29,
"character": 49,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L29"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "ReplayOption"
},
"name": "ReplayOption",
"package": "@supabase/realtime-js"
}
},
{
"id": 386,
"name": "self",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 29,
"character": 18,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L29"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"children": [387, 388, 386]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 29,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L29"
}
]
}
}
},
{
"id": 389,
"name": "presence",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "key option is used to track presence payload across clients"
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 33,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L33"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 390,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 392,
"name": "enabled",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 33,
"character": 31,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L33"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 391,
"name": "key",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 33,
"character": 17,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L33"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [392, 391]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 33,
"character": 15,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L33"
}
]
}
}
},
{
"id": 393,
"name": "private",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "defines if the channel is private or not and if RLS policies will be used to check data"
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 37,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L37"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"children": [384, 389, 393]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 23,
"character": 10,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L23"
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"children": [382]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 22,
"character": 37,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L22"
}
]
}
}
},
{
"id": 394,
"name": "RealtimeChannelSendResponse",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 128,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L128"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "timed out"
},
{
"type": "literal",
"value": "error"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 395,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 128,
"character": 83,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L128"
}
]
}
}
]
}
]
}
},
{
"id": 573,
"name": "RealtimeClientOptions",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 64,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L64"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 574,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 609,
"name": "accessToken",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 82,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L82"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 610,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 82,
"character": 16,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L82"
}
],
"signatures": [
{
"id": 611,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "literal",
"value": null
}
]
}
],
"name": "Promise",
"package": "typescript"
}
}
]
}
}
},
{
"id": 591,
"name": "decode",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 72,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L72"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "Decode"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Decode",
"package": "@supabase/phoenix"
}
},
{
"id": 612,
"name": "disconnectOnEmptyChannelsAfterMs",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 83,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L83"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 590,
"name": "encode",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 71,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L71"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/@supabase/phoenix/assets/js/phoenix/types.js",
"qualifiedName": "Encode"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Encode",
"package": "@supabase/phoenix"
}
},
{
"id": 606,
"name": "fetch",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 79,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L79"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "Fetch"
},
"name": "Fetch",
"package": "@supabase/realtime-js"
}
},
{
"id": 596,
"name": "headers",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 74,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L74"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 597,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 74,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L74"
}
],
"indexSignatures": [
{
"id": 598,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 74,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L74"
}
],
"parameters": [
{
"id": 599,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 578,
"name": "heartbeatCallback",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 68,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L68"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 579,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 68,
"character": 22,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L68"
}
],
"signatures": [
{
"id": 580,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"parameters": [
{
"id": 581,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "HeartbeatStatus"
},
"name": "HeartbeatStatus",
"package": "@supabase/realtime-js"
}
},
{
"id": 582,
"name": "latency",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
},
{
"id": 577,
"name": "heartbeatIntervalMs",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 67,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L67"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 604,
"name": "log_level",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 77,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L77"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "LogLevel"
},
"name": "LogLevel",
"package": "@supabase/realtime-js"
}
},
{
"id": 584,
"name": "logger",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 70,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L70"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 585,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 70,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L70"
}
],
"signatures": [
{
"id": 586,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"parameters": [
{
"id": 587,
"name": "kind",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 588,
"name": "msg",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 589,
"name": "data",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
},
{
"id": 605,
"name": "logLevel",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 78,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L78"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "LogLevel"
},
"name": "LogLevel",
"package": "@supabase/realtime-js"
}
},
{
"id": 600,
"name": "params",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 75,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L75"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 601,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 75,
"character": 11,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L75"
}
],
"indexSignatures": [
{
"id": 602,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 75,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L75"
}
],
"parameters": [
{
"id": 603,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
},
{
"id": 592,
"name": "reconnectAfterMs",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 73,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L73"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 593,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 73,
"character": 21,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L73"
}
],
"signatures": [
{
"id": 594,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"parameters": [
{
"id": 595,
"name": "tries",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
]
}
}
},
{
"id": 613,
"name": "sessionStorage",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Storage compatible object used by the underlying socket for longpoll fallback history.\nProvide a custom implementation in environments where reading "
},
{
"kind": "code",
"text": "`globalThis.sessionStorage`"
},
{
"kind": "text",
"text": "\nthrows (sandboxed iframes, in-app webviews, \"block third-party storage\" privacy modes).\nDefaults to "
},
{
"kind": "code",
"text": "`globalThis.sessionStorage`"
},
{
"kind": "text",
"text": " when accessible, otherwise an in-memory store."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 90,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L90"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Storage"
},
"name": "Storage",
"package": "typescript"
}
},
{
"id": 576,
"name": "timeout",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 66,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L66"
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 575,
"name": "transport",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 65,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L65"
}
],
"type": {
"type": "reference",
"target": 782,
"name": "WebSocketLikeConstructor",
"package": "@supabase/realtime-js"
}
},
{
"id": 583,
"name": "vsn",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 69,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L69"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 607,
"name": "worker",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 80,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L80"
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 608,
"name": "workerUrl",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 81,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L81"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [
609, 591, 612, 590, 606, 596, 578, 577, 604, 584, 605, 600, 592, 613, 576, 575, 583,
607, 608
]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 64,
"character": 36,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L64"
}
]
}
}
},
{
"id": 614,
"name": "RealtimeMessage",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 32,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L32"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 615,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 617,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 34,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L34"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 620,
"name": "join_ref",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 37,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L37"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 618,
"name": "payload",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 35,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L35"
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 619,
"name": "ref",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 36,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L36"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 616,
"name": "topic",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 33,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L33"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [617, 620, 618, 619, 616]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 32,
"character": 30,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L32"
}
]
}
}
},
{
"id": 621,
"name": "RealtimePostgresChangesFilter",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 109,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L109"
}
],
"typeParameters": [
{
"id": 627,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "templateLiteral",
"head": "",
"tail": [
[
{
"type": "reference",
"target": 698,
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT",
"package": "@supabase/realtime-js"
},
""
]
]
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 622,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 623,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The type of database change to listen to."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 113,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L113"
}
],
"type": {
"type": "reference",
"target": 627,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
},
{
"id": 626,
"name": "filter",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Receive database changes when filter is matched."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 125,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L125"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 624,
"name": "schema",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The database schema to listen to."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 117,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L117"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 625,
"name": "table",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The database table to listen to."
}
]
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 121,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L121"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [623, 626, 624, 625]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 109,
"character": 99,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L109"
}
]
}
}
},
{
"id": 628,
"name": "RealtimePostgresChangesPayload",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 104,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L104"
}
],
"typeParameters": [
{
"id": 629,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 630,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 104,
"character": 53,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L104"
}
],
"indexSignatures": [
{
"id": 631,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 104,
"character": 55,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L104"
}
],
"parameters": [
{
"id": 632,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"target": 633,
"typeArguments": [
{
"type": "reference",
"target": 629,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresInsertPayload",
"package": "@supabase/realtime-js"
},
{
"type": "reference",
"target": 643,
"typeArguments": [
{
"type": "reference",
"target": 629,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresUpdatePayload",
"package": "@supabase/realtime-js"
},
{
"type": "reference",
"target": 652,
"typeArguments": [
{
"type": "reference",
"target": 629,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "RealtimePostgresDeletePayload",
"package": "@supabase/realtime-js"
}
]
}
},
{
"id": 652,
"name": "RealtimePostgresDeletePayload",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 97,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L97"
}
],
"typeParameters": [
{
"id": 658,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 659,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 97,
"character": 52,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L97"
}
],
"indexSignatures": [
{
"id": 660,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 97,
"character": 54,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L97"
}
],
"parameters": [
{
"id": 661,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"type": {
"type": "intersection",
"types": [
{
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresChangesPayloadBase"
},
"name": "RealtimePostgresChangesPayloadBase",
"package": "@supabase/realtime-js"
},
{
"type": "reflection",
"declaration": {
"id": 653,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 654,
"name": "eventType",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 99,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L99"
}
],
"type": {
"type": "templateLiteral",
"head": "",
"tail": [
[
{
"type": "reference",
"target": 702,
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE",
"package": "@supabase/realtime-js"
},
""
]
]
}
},
{
"id": 655,
"name": "new",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 100,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L100"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 656,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 100,
"character": 9,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L100"
}
]
}
}
},
{
"id": 657,
"name": "old",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 101,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L101"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Partial"
},
"typeArguments": [
{
"type": "reference",
"target": 658,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "Partial",
"package": "typescript"
}
}
],
"groups": [
{
"title": "Properties",
"children": [654, 655, 657]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 98,
"character": 39,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L98"
}
]
}
}
]
}
},
{
"id": 633,
"name": "RealtimePostgresInsertPayload",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 83,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L83"
}
],
"typeParameters": [
{
"id": 639,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 640,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 83,
"character": 52,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L83"
}
],
"indexSignatures": [
{
"id": 641,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 83,
"character": 54,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L83"
}
],
"parameters": [
{
"id": 642,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"type": {
"type": "intersection",
"types": [
{
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresChangesPayloadBase"
},
"name": "RealtimePostgresChangesPayloadBase",
"package": "@supabase/realtime-js"
},
{
"type": "reflection",
"declaration": {
"id": 634,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 635,
"name": "eventType",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 85,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L85"
}
],
"type": {
"type": "templateLiteral",
"head": "",
"tail": [
[
{
"type": "reference",
"target": 700,
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT",
"package": "@supabase/realtime-js"
},
""
]
]
}
},
{
"id": 636,
"name": "new",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 86,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L86"
}
],
"type": {
"type": "reference",
"target": 639,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
},
{
"id": 637,
"name": "old",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 87,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L87"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 638,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 87,
"character": 9,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L87"
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"children": [635, 636, 637]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 84,
"character": 39,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L84"
}
]
}
}
]
}
},
{
"id": 643,
"name": "RealtimePostgresUpdatePayload",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 90,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L90"
}
],
"typeParameters": [
{
"id": 648,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 649,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 90,
"character": 52,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L90"
}
],
"indexSignatures": [
{
"id": 650,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 90,
"character": 54,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L90"
}
],
"parameters": [
{
"id": 651,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"type": {
"type": "intersection",
"types": [
{
"type": "reference",
"target": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresChangesPayloadBase"
},
"name": "RealtimePostgresChangesPayloadBase",
"package": "@supabase/realtime-js"
},
{
"type": "reflection",
"declaration": {
"id": 644,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 645,
"name": "eventType",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 92,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L92"
}
],
"type": {
"type": "templateLiteral",
"head": "",
"tail": [
[
{
"type": "reference",
"target": 701,
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE",
"package": "@supabase/realtime-js"
},
""
]
]
}
},
{
"id": 646,
"name": "new",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 93,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L93"
}
],
"type": {
"type": "reference",
"target": 648,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
},
{
"id": 647,
"name": "old",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 94,
"character": 4,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L94"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Partial"
},
"typeArguments": [
{
"type": "reference",
"target": 648,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "Partial",
"package": "typescript"
}
}
],
"groups": [
{
"title": "Properties",
"children": [645, 646, 647]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 91,
"character": 39,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L91"
}
]
}
}
]
}
},
{
"id": 662,
"name": "RealtimePresenceJoinPayload",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 17,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L17"
}
],
"typeParameters": [
{
"id": 668,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 669,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 17,
"character": 50,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L17"
}
],
"indexSignatures": [
{
"id": 670,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 17,
"character": 52,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L17"
}
],
"parameters": [
{
"id": 671,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 663,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 666,
"name": "currentPresences",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 20,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L20"
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "Presence"
},
"typeArguments": [
{
"type": "reference",
"target": 668,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "Presence",
"package": "@supabase/realtime-js"
}
}
},
{
"id": 664,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 18,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L18"
}
],
"type": {
"type": "templateLiteral",
"head": "",
"tail": [
[
{
"type": "reference",
"target": 705,
"name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN",
"package": "@supabase/realtime-js"
},
""
]
]
}
},
{
"id": 665,
"name": "key",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 19,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L19"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 667,
"name": "newPresences",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 21,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L21"
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "Presence"
},
"typeArguments": [
{
"type": "reference",
"target": 668,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "Presence",
"package": "@supabase/realtime-js"
}
}
}
],
"groups": [
{
"title": "Properties",
"children": [666, 664, 665, 667]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 17,
"character": 76,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L17"
}
]
}
}
},
{
"id": 672,
"name": "RealtimePresenceLeavePayload",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 24,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L24"
}
],
"typeParameters": [
{
"id": 678,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 679,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 24,
"character": 51,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L24"
}
],
"indexSignatures": [
{
"id": 680,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 24,
"character": 53,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L24"
}
],
"parameters": [
{
"id": 681,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 673,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 676,
"name": "currentPresences",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 27,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L27"
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "Presence"
},
"typeArguments": [
{
"type": "reference",
"target": 678,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "Presence",
"package": "@supabase/realtime-js"
}
}
},
{
"id": 674,
"name": "event",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 25,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L25"
}
],
"type": {
"type": "templateLiteral",
"head": "",
"tail": [
[
{
"type": "reference",
"target": 706,
"name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE",
"package": "@supabase/realtime-js"
},
""
]
]
}
},
{
"id": 675,
"name": "key",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 26,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L26"
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 677,
"name": "leftPresences",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 28,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L28"
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "Presence"
},
"typeArguments": [
{
"type": "reference",
"target": 678,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "Presence",
"package": "@supabase/realtime-js"
}
}
}
],
"groups": [
{
"title": "Properties",
"children": [676, 674, 675, 677]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 24,
"character": 77,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L24"
}
]
}
}
},
{
"id": 682,
"name": "RealtimePresenceState",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 13,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L13"
}
],
"typeParameters": [
{
"id": 686,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 687,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 13,
"character": 44,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L13"
}
],
"indexSignatures": [
{
"id": 688,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 13,
"character": 46,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L13"
}
],
"parameters": [
{
"id": 689,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
},
"default": {
"type": "reflection",
"declaration": {
"id": 690,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 13,
"character": 69,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L13"
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 683,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 13,
"character": 75,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L13"
}
],
"indexSignatures": [
{
"id": 684,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimePresence.ts",
"line": 14,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimePresence.ts#L14"
}
],
"parameters": [
{
"id": 685,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "Presence"
},
"typeArguments": [
{
"type": "reference",
"target": 686,
"name": "T",
"package": "@supabase/realtime-js",
"refersToTypeParameter": true
}
],
"name": "Presence",
"package": "@supabase/realtime-js"
}
}
}
]
}
}
},
{
"id": 691,
"name": "RealtimeRemoveChannelResponse",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 40,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L40"
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "timed out"
},
{
"type": "literal",
"value": "error"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 692,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeClient.ts",
"line": 40,
"character": 85,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeClient.ts#L40"
}
]
}
}
]
}
]
}
},
{
"id": 712,
"name": "REALTIME_CHANNEL_STATES",
"variant": "declaration",
"kind": 32,
"flags": {
"isConst": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/RealtimeChannel.ts",
"line": 151,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/RealtimeChannel.ts#L151"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 713,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 714,
"name": "closed",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/constants.ts",
"line": 33,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/constants.ts#L33"
}
],
"type": {
"type": "literal",
"value": "closed"
},
"defaultValue": "'closed'"
},
{
"id": 715,
"name": "errored",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/constants.ts",
"line": 34,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/constants.ts#L34"
}
],
"type": {
"type": "literal",
"value": "errored"
},
"defaultValue": "'errored'"
},
{
"id": 716,
"name": "joined",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/constants.ts",
"line": 35,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/constants.ts#L35"
}
],
"type": {
"type": "literal",
"value": "joined"
},
"defaultValue": "'joined'"
},
{
"id": 717,
"name": "joining",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/constants.ts",
"line": 36,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/constants.ts#L36"
}
],
"type": {
"type": "literal",
"value": "joining"
},
"defaultValue": "'joining'"
},
{
"id": 718,
"name": "leaving",
"variant": "declaration",
"kind": 1024,
"flags": {
"isReadonly": true
},
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/constants.ts",
"line": 37,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/constants.ts#L37"
}
],
"type": {
"type": "literal",
"value": "leaving"
},
"defaultValue": "'leaving'"
}
],
"groups": [
{
"title": "Properties",
"children": [714, 715, 716, 717, 718]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/src/lib/constants.ts",
"line": 32,
"character": 30,
"url": "https://github.com/supabase/supabase-js/blob/23f365cf2acac09f7b51cb507e39c1e57a18f5ea/packages/core/realtime-js/src/lib/constants.ts#L32"
}
]
}
},
"defaultValue": "CHANNEL_STATES"
}
],
"groups": [
{
"title": "Enumerations",
"children": [693, 698, 703, 707]
},
{
"title": "Classes",
"children": [10, 396, 1, 719]
},
{
"title": "Interfaces",
"children": [732, 782]
},
{
"title": "Type Aliases",
"children": [380, 394, 573, 614, 621, 628, 652, 633, 643, 662, 672, 682, 691]
},
{
"title": "Variables",
"children": [712]
}
],
"packageName": "@supabase/realtime-js",
"readme": [
{
"kind": "text",
"text": "<br />\n<p align=\"center\">\n <a href=\"https://supabase.io\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg\">\n <img alt=\"Supabase Logo\" width=\"300\" src=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg\">\n </picture>\n </a>\n\n <h1 align=\"center\">Supabase Realtime JS SDK</h1>\n\n <h3 align=\"center\">Send ephemeral messages with <b>Broadcast</b>, track and synchronize state with <b>Presence</b>, and listen to database changes with <b>Postgres Change Data Capture (CDC)</b>.</h3>\n\n <p align=\"center\">\n <a href=\"https://supabase.com/docs/guides/realtime\">Guides</a>\n ·\n <a href=\"https://supabase.com/docs/reference/javascript\">Reference Docs</a>\n ·\n <a href=\"https://multiplayer.dev\">Multiplayer Demo</a>\n </p>\n</p>\n\n<div align=\"center\">\n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/realtime-js)](https://www.npmjs.com/package/@supabase/realtime-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)\n\n</div>\n\n# Overview\n\nThis SDK enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n"
},
{
"kind": "code",
"text": "```bash\nnpm install @supabase/realtime-js\n```"
},
{
"kind": "text",
"text": "\n\n## Creating a Channel\n\n"
},
{
"kind": "code",
"text": "```js\nimport { RealtimeClient } from '@supabase/realtime-js'\n\nconst client = new RealtimeClient(REALTIME_URL, {\n params: {\n apikey: API_KEY,\n },\n})\n\nconst channel = client.channel('test-channel', {})\n\nchannel.subscribe((status, err) => {\n if (status === 'SUBSCRIBED') {\n console.log('Connected!')\n }\n\n if (status === 'CHANNEL_ERROR') {\n console.log(`There was an error subscribing to channel: ${err.message}`)\n }\n\n if (status === 'TIMED_OUT') {\n console.log('Realtime server did not respond in time.')\n }\n\n if (status === 'CLOSED') {\n console.log('Realtime channel was unexpectedly closed.')\n }\n})\n```"
},
{
"kind": "text",
"text": "\n\n### Notes:\n\n- "
},
{
"kind": "code",
"text": "`REALTIME_URL`"
},
{
"kind": "text",
"text": " is "
},
{
"kind": "code",
"text": "`'ws://localhost:4000/socket'`"
},
{
"kind": "text",
"text": " when developing locally and "
},
{
"kind": "code",
"text": "`'wss://<project_ref>.supabase.co/realtime/v1'`"
},
{
"kind": "text",
"text": " when connecting to your Supabase project.\n- "
},
{
"kind": "code",
"text": "`API_KEY`"
},
{
"kind": "text",
"text": " is a JWT whose claims must contain "
},
{
"kind": "code",
"text": "`exp`"
},
{
"kind": "text",
"text": " and "
},
{
"kind": "code",
"text": "`role`"
},
{
"kind": "text",
"text": " (existing database role).\n- Channel name can be any "
},
{
"kind": "code",
"text": "`string`"
},
{
"kind": "text",
"text": ".\n- Setting "
},
{
"kind": "code",
"text": "`private`"
},
{
"kind": "text",
"text": " to "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": " means that the client will use RLS to determine if the user can connect or not to a given channel.\n\n## Broadcast\n\nYour client can send and receive messages based on the "
},
{
"kind": "code",
"text": "`event`"
},
{
"kind": "text",
"text": ".\n\n"
},
{
"kind": "code",
"text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) => console.log(payload))\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```"
},
{
"kind": "text",
"text": "\n\n### Notes:\n\n- Setting "
},
{
"kind": "code",
"text": "`ack`"
},
{
"kind": "text",
"text": " to "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": " means that the "
},
{
"kind": "code",
"text": "`channel.send`"
},
{
"kind": "text",
"text": " promise will resolve once server replies with acknowledgment that it received the broadcast message request.\n- Setting "
},
{
"kind": "code",
"text": "`self`"
},
{
"kind": "text",
"text": " to "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": " means that the client will receive the broadcast message it sent out.\n\n### Broadcast Replay\n\nBroadcast Replay enables **private** channels to access messages that were sent earlier. Only messages published via [Broadcast From the Database](https://supabase.com/docs/guides/realtime/broadcast#trigger-broadcast-messages-from-your-database) are available for replay.\n\nYou can configure replay with the following options:\n\n- **"
},
{
"kind": "code",
"text": "`since`"
},
{
"kind": "text",
"text": "** (Required): The epoch timestamp in milliseconds, specifying the earliest point from which messages should be retrieved.\n- **"
},
{
"kind": "code",
"text": "`limit`"
},
{
"kind": "text",
"text": "** (Optional): The number of messages to return. This must be a positive integer, with a maximum value of 25.\n\nExample:\n\n"
},
{
"kind": "code",
"text": "```typescript\nconst twelveHours = 12 * 60 * 60 * 1000\nconst twelveHoursAgo = Date.now() - twelveHours\n\nconst config = { private: true, broadcast: { replay: { since: twelveHoursAgo, limit: 10 } } }\n\nsupabase\n .channel('main:room', { config })\n .on('broadcast', { event: 'my_event' }, (payload) => {\n if (payload?.meta?.replayed) {\n console.log('This message was sent earlier:', payload)\n } else {\n console.log('This is a new message', payload)\n }\n // ...\n })\n .subscribe()\n```"
},
{
"kind": "text",
"text": "\n\n## Presence\n\nYour client can track and sync state that's stored in the channel.\n\n"
},
{
"kind": "code",
"text": "```js\n// Setup...\n\nconst channel = client.channel('presence-test', {\n config: {\n presence: {\n key: '',\n },\n },\n})\n\nchannel.on('presence', { event: 'sync' }, () => {\n console.log('Online users: ', channel.presenceState())\n})\n\nchannel.on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('New users have joined: ', newPresences)\n})\n\nchannel.on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Users have left: ', leftPresences)\n})\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n const status = await channel.track({ user_id: 1 })\n console.log(status)\n }\n})\n```"
},
{
"kind": "text",
"text": "\n\n## Postgres CDC\n\nReceive database changes on the client.\n\n"
},
{
"kind": "code",
"text": "```js\n// Setup...\n\nconst channel = client.channel('db-changes')\n\nchannel.on('postgres_changes', { event: '*', schema: 'public' }, (payload) => {\n console.log('All changes in public schema: ', payload)\n})\n\nchannel.on(\n 'postgres_changes',\n { event: 'INSERT', schema: 'public', table: 'messages' },\n (payload) => {\n console.log('All inserts in messages table: ', payload)\n }\n)\n\nchannel.on(\n 'postgres_changes',\n { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' },\n (payload) => {\n console.log('All updates on users table when username is Realtime: ', payload)\n }\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n console.log('Ready to receive database changes!')\n }\n})\n```"
},
{
"kind": "text",
"text": "\n\n## Get All Channels\n\nYou can see all the channels that your client has instantiatied.\n\n"
},
{
"kind": "code",
"text": "```js\n// Setup...\n\nclient.getChannels()\n```"
},
{
"kind": "text",
"text": "\n\n## Cleanup\n\nIt is highly recommended that you clean up your channels after you're done with them.\n\n- Remove a single channel\n\n"
},
{
"kind": "code",
"text": "```js\n// Setup...\n\nconst channel = client.channel('some-channel-to-remove')\n\nchannel.unsubscribe()\nclient.removeChannel(channel)\n```"
},
{
"kind": "text",
"text": "\n\n- Remove all channels and close the connection\n\n"
},
{
"kind": "code",
"text": "```js\n// Setup...\n\nclient.removeAllChannels()\nclient.disconnect()\n```"
},
{
"kind": "text",
"text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n"
},
{
"kind": "code",
"text": "```bash\n# Complete build (from monorepo root)\nnpx nx build realtime-js\n\n# Build with watch mode for development\nnpx nx build realtime-js --watch\n\n# Individual build targets\nnpx nx build:main realtime-js # CommonJS build (dist/main/)\nnpx nx build:module realtime-js # ES Modules build (dist/module/)\n\n# Other useful commands\nnpx nx clean realtime-js # Clean build artifacts\nnpx nx lint realtime-js # Run ESLint\nnpx nx typecheck realtime-js # TypeScript type checking\n```"
},
{
"kind": "text",
"text": "\n\n#### Build Outputs\n\n- **CommonJS ("
},
{
"kind": "code",
"text": "`dist/main/`"
},
{
"kind": "text",
"text": ")** - For Node.js environments\n- **ES Modules ("
},
{
"kind": "code",
"text": "`dist/module/`"
},
{
"kind": "text",
"text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions ("
},
{
"kind": "code",
"text": "`dist/module/index.d.ts`"
},
{
"kind": "text",
"text": ")** - Type definitions for TypeScript projects\n\nNote: Unlike some other packages, realtime-js doesn't include a UMD build since it's primarily used in Node.js or bundled applications.\n\n#### Validating Package Exports\n\n"
},
{
"kind": "code",
"text": "```bash\n# Check if package exports are correctly configured\nnpx nx check-exports realtime-js\n```"
},
{
"kind": "text",
"text": "\n\nThis command uses [\"Are the types wrong?\"](https://github.com/arethetypeswrong/arethetypeswrong.github.io) to verify that the package exports work correctly in different environments. Run this before publishing to ensure your package can be imported correctly by all consumers.\n\n### Testing\n\n**No Docker or Supabase instance required!** The realtime-js tests use mocked WebSocket connections, so they're completely self-contained.\n\n"
},
{
"kind": "code",
"text": "```bash\n# Run unit tests (from monorepo root)\nnpx nx test realtime-js\n\n# Run tests with coverage report\nnpx nx test:coverage realtime-js\n\n# Run tests in watch mode during development\nnpx nx test:watch realtime-js\n```"
},
{
"kind": "text",
"text": "\n\n#### Test Scripts Explained\n\n- **test** - Runs all unit tests once using Vitest\n- **test:coverage** - Runs tests and generates coverage report with terminal output\n- **test:watch** - Runs tests in interactive watch mode for development\n\nThe tests mock WebSocket connections using "
},
{
"kind": "code",
"text": "`mock-socket`"
},
{
"kind": "text",
"text": ", so you can run them anytime without any external dependencies.\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide]("
},
{
"kind": "relative-link",
"text": "../../../CONTRIBUTING.md",
"target": 2
},
{
"kind": "text",
"text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n## Credits\n\nThis repo draws heavily from [phoenix-js](https://github.com/phoenixframework/phoenix/tree/master/assets/js/phoenix).\n\n## License\n\nMIT."
}
],
"symbolIdMap": {
"0": {
"sourceFileName": "src/index.ts",
"qualifiedName": ""
},
"1": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "default"
},
"2": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "default.__constructor"
},
"3": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "default"
},
"4": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "channel"
},
"5": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "opts"
},
"6": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "default.state"
},
"7": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "default.state"
},
"9": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "default.channel"
},
"10": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default"
},
"15": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.__constructor"
},
"16": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default"
},
"17": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "topic"
},
"18": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "params"
},
"19": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "socket"
},
"20": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.bindings"
},
"21": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.subTopic"
},
"22": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.broadcastEndpointURL"
},
"23": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.private"
},
"24": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.presence"
},
"26": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.state"
},
"27": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.state"
},
"28": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.state"
},
"29": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "state"
},
"30": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.joinedOnce"
},
"31": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.joinedOnce"
},
"32": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.timeout"
},
"33": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.timeout"
},
"34": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.joinPush"
},
"35": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.joinPush"
},
"36": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.rejoinTimer"
},
"37": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.rejoinTimer"
},
"38": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.topic"
},
"39": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.params"
},
"40": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.socket"
},
"41": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.subscribe"
},
"42": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.subscribe"
},
"43": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"44": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"45": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"46": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "status"
},
"47": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "err"
},
"48": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "timeout"
},
"63": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.presenceState"
},
"64": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.presenceState"
},
"65": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"66": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"67": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"69": {
"sourceFileName": "",
"qualifiedName": "__type"
},
"70": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.track"
},
"71": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.track"
},
"72": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"73": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"74": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"76": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "opts"
},
"77": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"78": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"80": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.untrack"
},
"81": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.untrack"
},
"82": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "opts"
},
"83": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"84": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"86": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"87": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"88": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"89": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"90": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"91": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"92": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"93": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"94": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"95": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"96": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"97": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"98": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"100": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"101": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"102": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"103": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"104": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"105": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"106": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"107": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"108": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"109": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"110": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"111": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"113": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"114": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"115": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"116": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"117": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"118": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"119": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"120": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"121": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"122": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"123": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"124": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"126": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"127": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"128": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"129": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"130": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"131": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"132": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"133": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"134": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"135": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"136": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"137": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"139": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"140": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"141": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"142": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"143": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"144": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"145": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"146": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"147": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"148": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"150": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"151": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"152": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"153": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"154": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"155": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"156": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"157": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"158": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"159": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"161": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"162": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"163": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"164": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"165": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"166": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"167": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"168": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"169": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"170": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"172": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"173": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"174": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"175": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"176": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"177": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"178": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"179": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"180": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"181": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"183": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"184": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"185": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"186": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"187": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"188": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"189": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"190": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"191": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"192": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"193": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"194": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"195": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"196": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"197": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"198": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"199": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.type"
},
"200": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"201": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.meta"
},
"202": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"203": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.replayed"
},
"204": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.id"
},
"205": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"207": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"208": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"209": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"210": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"212": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"213": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"214": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"215": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"216": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"217": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"218": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"219": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"220": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"221": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.type"
},
"222": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"223": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.meta"
},
"224": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"225": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.replayed"
},
"226": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.id"
},
"227": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.payload"
},
"228": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"229": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"230": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"231": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"232": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"233": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"234": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"235": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"236": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"237": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"238": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"239": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.type"
},
"240": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"241": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.payload"
},
"242": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"243": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"244": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"245": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"247": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"248": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"249": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"250": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"251": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"252": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"253": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"254": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"255": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"256": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.type"
},
"257": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"258": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.payload"
},
"259": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"260": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"261": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"262": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"264": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"265": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"266": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"267": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"268": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"269": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"270": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"271": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"272": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"273": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.type"
},
"274": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"275": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.payload"
},
"276": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"277": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"278": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"279": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"281": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"282": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"283": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"284": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"285": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"286": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"287": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"288": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"289": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"290": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.type"
},
"291": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"292": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.payload"
},
"293": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.on"
},
"294": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"295": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"296": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"298": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "type"
},
"299": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "filter"
},
"300": {
"sourceFileName": "",
"qualifiedName": "__type"
},
"301": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "callback"
},
"302": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"303": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"304": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"305": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.httpSend"
},
"306": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.httpSend"
},
"307": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "event"
},
"308": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"309": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "opts"
},
"310": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"311": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.timeout"
},
"312": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"313": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.success"
},
"314": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"315": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.success"
},
"316": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.status"
},
"317": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.error"
},
"318": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.send"
},
"319": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.send"
},
"320": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "args"
},
"321": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"322": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.type"
},
"323": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"324": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.payload"
},
"325": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"327": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "opts"
},
"328": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"329": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"331": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.updateJoinPayload"
},
"332": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.updateJoinPayload"
},
"333": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "payload"
},
"334": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.unsubscribe"
},
"335": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.unsubscribe"
},
"336": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "timeout"
},
"337": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.teardown"
},
"338": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.teardown"
},
"369": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.copyBindings"
},
"370": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "default.copyBindings"
},
"371": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "other"
},
"380": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimeChannelOptions"
},
"381": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"382": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.config"
},
"383": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"384": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.broadcast"
},
"385": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"386": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.self"
},
"387": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.ack"
},
"388": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.replay"
},
"389": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.presence"
},
"390": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"391": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.key"
},
"392": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.enabled"
},
"393": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.private"
},
"394": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimeChannelSendResponse"
},
"395": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"396": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default"
},
"397": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.__constructor"
},
"398": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default"
},
"399": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "endPoint"
},
"400": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "options"
},
"402": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.channels"
},
"403": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.accessTokenValue"
},
"404": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.accessToken"
},
"405": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"406": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"407": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.apiKey"
},
"408": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.httpEndpoint"
},
"409": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.headers"
},
"410": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"411": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.__index"
},
"413": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.params"
},
"414": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"415": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.__index"
},
"417": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.ref"
},
"418": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.logLevel"
},
"419": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.fetch"
},
"420": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "fetch"
},
"421": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "fetch"
},
"422": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "input"
},
"423": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "init"
},
"424": {
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
"qualifiedName": "fetch"
},
"425": {
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
"qualifiedName": "input"
},
"426": {
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
"qualifiedName": "init"
},
"427": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.worker"
},
"428": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.workerUrl"
},
"429": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.workerRef"
},
"430": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.serializer"
},
"431": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.endPoint"
},
"432": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.endPoint"
},
"433": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.timeout"
},
"434": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.timeout"
},
"435": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.transport"
},
"436": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.transport"
},
"437": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.heartbeatCallback"
},
"438": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.heartbeatCallback"
},
"439": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.heartbeatIntervalMs"
},
"440": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.heartbeatIntervalMs"
},
"441": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.heartbeatTimer"
},
"442": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.heartbeatTimer"
},
"443": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.pendingHeartbeatRef"
},
"444": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.pendingHeartbeatRef"
},
"445": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.reconnectTimer"
},
"446": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.reconnectTimer"
},
"447": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.vsn"
},
"448": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.vsn"
},
"449": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.encode"
},
"450": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.encode"
},
"451": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.decode"
},
"452": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.decode"
},
"453": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.reconnectAfterMs"
},
"454": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.reconnectAfterMs"
},
"455": {
"sourceFileName": "src/phoenix/socketAdapter.ts",
"qualifiedName": "__type"
},
"456": {
"sourceFileName": "src/phoenix/socketAdapter.ts",
"qualifiedName": "__type"
},
"457": {
"sourceFileName": "src/phoenix/socketAdapter.ts",
"qualifiedName": "tries"
},
"458": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.sendBuffer"
},
"459": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.sendBuffer"
},
"460": {
"sourceFileName": "src/phoenix/socketAdapter.ts",
"qualifiedName": "__type"
},
"461": {
"sourceFileName": "src/phoenix/socketAdapter.ts",
"qualifiedName": "__type"
},
"462": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.stateChangeCallbacks"
},
"463": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.stateChangeCallbacks"
},
"464": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"465": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.open"
},
"466": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.close"
},
"467": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.error"
},
"468": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.message"
},
"475": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.connect"
},
"476": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.connect"
},
"477": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.endpointURL"
},
"478": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.endpointURL"
},
"479": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.disconnect"
},
"480": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.disconnect"
},
"481": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "code"
},
"482": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "reason"
},
"483": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.getChannels"
},
"484": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.getChannels"
},
"485": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.removeChannel"
},
"486": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.removeChannel"
},
"487": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "channel"
},
"488": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.removeAllChannels"
},
"489": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.removeAllChannels"
},
"490": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.log"
},
"491": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.log"
},
"492": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "kind"
},
"493": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "msg"
},
"494": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "data"
},
"495": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.connectionState"
},
"496": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.connectionState"
},
"497": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.isConnected"
},
"498": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.isConnected"
},
"499": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.isConnecting"
},
"500": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.isConnecting"
},
"501": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.isDisconnecting"
},
"502": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.isDisconnecting"
},
"503": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.channel"
},
"504": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.channel"
},
"505": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "topic"
},
"506": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "params"
},
"507": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.push"
},
"508": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.push"
},
"509": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "data"
},
"510": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.setAuth"
},
"511": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.setAuth"
},
"512": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "token"
},
"515": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.sendHeartbeat"
},
"516": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.sendHeartbeat"
},
"517": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.onHeartbeat"
},
"518": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "default.onHeartbeat"
},
"519": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "callback"
},
"573": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "RealtimeClientOptions"
},
"574": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"575": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.transport"
},
"576": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.timeout"
},
"577": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.heartbeatIntervalMs"
},
"578": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.heartbeatCallback"
},
"579": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"580": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"581": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "status"
},
"582": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "latency"
},
"583": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.vsn"
},
"584": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.logger"
},
"585": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"586": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"587": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "kind"
},
"588": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "msg"
},
"589": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "data"
},
"590": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.encode"
},
"591": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.decode"
},
"592": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.reconnectAfterMs"
},
"593": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"594": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"595": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "tries"
},
"596": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.headers"
},
"597": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"598": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.__index"
},
"600": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.params"
},
"601": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"602": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.__index"
},
"604": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.log_level"
},
"605": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.logLevel"
},
"606": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.fetch"
},
"607": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.worker"
},
"608": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.workerUrl"
},
"609": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.accessToken"
},
"610": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"611": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"612": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.disconnectOnEmptyChannelsAfterMs"
},
"613": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.sessionStorage"
},
"614": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "RealtimeMessage"
},
"615": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"616": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.topic"
},
"617": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.event"
},
"618": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.payload"
},
"619": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.ref"
},
"620": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type.join_ref"
},
"621": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresChangesFilter"
},
"622": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"623": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.event"
},
"624": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.schema"
},
"625": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.table"
},
"626": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.filter"
},
"627": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"628": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresChangesPayload"
},
"629": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"630": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"631": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"633": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresInsertPayload"
},
"634": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"635": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.eventType"
},
"636": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.new"
},
"637": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.old"
},
"638": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"639": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"640": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"641": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"643": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresUpdatePayload"
},
"644": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"645": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.eventType"
},
"646": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.new"
},
"647": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.old"
},
"648": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"649": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"650": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"652": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "RealtimePostgresDeletePayload"
},
"653": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"654": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.eventType"
},
"655": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.new"
},
"656": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"657": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.old"
},
"658": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "T"
},
"659": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type"
},
"660": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "__type.__index"
},
"662": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "RealtimePresenceJoinPayload"
},
"663": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type"
},
"664": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.event"
},
"665": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.key"
},
"666": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.currentPresences"
},
"667": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.newPresences"
},
"668": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "T"
},
"669": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type"
},
"670": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.__index"
},
"672": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "RealtimePresenceLeavePayload"
},
"673": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type"
},
"674": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.event"
},
"675": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.key"
},
"676": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.currentPresences"
},
"677": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.leftPresences"
},
"678": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "T"
},
"679": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type"
},
"680": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.__index"
},
"682": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "RealtimePresenceState"
},
"683": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type"
},
"684": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.__index"
},
"686": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "T"
},
"687": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type"
},
"688": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type.__index"
},
"690": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "__type"
},
"691": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "RealtimeRemoveChannelResponse"
},
"692": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "__type"
},
"693": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_LISTEN_TYPES"
},
"694": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST"
},
"695": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE"
},
"696": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES"
},
"697": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM"
},
"698": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT"
},
"699": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL"
},
"700": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT"
},
"701": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE"
},
"702": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE"
},
"703": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS"
},
"704": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC"
},
"705": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN"
},
"706": {
"sourceFileName": "src/RealtimePresence.ts",
"qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE"
},
"707": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_SUBSCRIBE_STATES"
},
"708": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED"
},
"709": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT"
},
"710": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED"
},
"711": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR"
},
"712": {
"sourceFileName": "src/RealtimeChannel.ts",
"qualifiedName": "REALTIME_CHANNEL_STATES"
},
"713": {
"sourceFileName": "src/lib/constants.ts",
"qualifiedName": "__object"
},
"714": {
"sourceFileName": "src/lib/constants.ts",
"qualifiedName": "__object.closed"
},
"715": {
"sourceFileName": "src/lib/constants.ts",
"qualifiedName": "__object.errored"
},
"716": {
"sourceFileName": "src/lib/constants.ts",
"qualifiedName": "__object.joined"
},
"717": {
"sourceFileName": "src/lib/constants.ts",
"qualifiedName": "__object.joining"
},
"718": {
"sourceFileName": "src/lib/constants.ts",
"qualifiedName": "__object.leaving"
},
"719": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketFactory"
},
"722": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketFactory.getWebSocketConstructor"
},
"723": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketFactory.getWebSocketConstructor"
},
"724": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "__type"
},
"725": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "__type"
},
"726": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "url"
},
"727": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "protocols"
},
"728": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketFactory.isWebSocketSupported"
},
"729": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketFactory.isWebSocketSupported"
},
"732": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike"
},
"733": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.CONNECTING"
},
"734": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.OPEN"
},
"735": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.CLOSING"
},
"736": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.CLOSED"
},
"737": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.readyState"
},
"738": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.url"
},
"739": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.protocol"
},
"740": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.close"
},
"741": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.close"
},
"742": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "code"
},
"743": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "reason"
},
"744": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.send"
},
"745": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.send"
},
"746": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "data"
},
"747": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.onopen"
},
"748": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"749": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"750": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "this"
},
"751": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "ev"
},
"752": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.onmessage"
},
"753": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"754": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"755": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "this"
},
"756": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "ev"
},
"757": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.onclose"
},
"758": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"759": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"760": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "this"
},
"761": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "ev"
},
"762": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.onerror"
},
"763": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"764": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"765": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "this"
},
"766": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "ev"
},
"767": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.addEventListener"
},
"768": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.addEventListener"
},
"769": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "type"
},
"770": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "listener"
},
"771": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.removeEventListener"
},
"772": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.removeEventListener"
},
"773": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "type"
},
"774": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "listener"
},
"775": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.binaryType"
},
"776": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.bufferedAmount"
},
"777": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.extensions"
},
"778": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "WebSocketLike.dispatchEvent"
},
"779": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"780": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "__type"
},
"781": {
"sourceFileName": "src/lib/websocket-factory.ts",
"qualifiedName": "event"
},
"782": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "WebSocketLikeConstructor"
},
"783": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "WebSocketLikeConstructor"
},
"784": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "WebSocketLikeConstructor"
},
"785": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "address"
},
"786": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "subprotocols"
},
"787": {
"sourceFileName": "src/RealtimeClient.ts",
"qualifiedName": "WebSocketLikeConstructor.__index"
}
},
"files": {
"entries": {
"1": "src/index.ts",
"2": "../../../CONTRIBUTING.md"
},
"reflections": {
"1": 0
}
}
}