lywsvip/supabase
1
0
Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-07-06 16:44:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
f115a6e53a26d50488c94de5b55fc3a01f3cfbca
supabase/web/spec/tsdoc_v2/realtime.json
Inian f08d6ac251 update realtime docs
2022-08-16 20:32:04 +08:00

5973 lines
121 KiB
JSON
Raw Blame History

{
"id": 0,
"name": "@supabase/realtime-js",
"kind": 1,
"kindString": "Project",
"flags": {},
"originalName": "",
"children": [
{
"id": 363,
"name": "Transformers",
"kind": 4,
"kindString": "Namespace",
"flags": {},
"children": [
{
"id": 364,
"name": "PostgresTypes",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"comment": {
"shortText": "Helpers to convert the change Payload into native JS types."
},
"children": [
{
"id": 365,
"name": "abstime",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 9,
"character": 2
}
],
"type": {
"type": "literal",
"value": "abstime"
},
"defaultValue": "\"abstime\""
},
{
"id": 366,
"name": "bool",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 10,
"character": 2
}
],
"type": {
"type": "literal",
"value": "bool"
},
"defaultValue": "\"bool\""
},
{
"id": 367,
"name": "date",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 11,
"character": 2
}
],
"type": {
"type": "literal",
"value": "date"
},
"defaultValue": "\"date\""
},
{
"id": 368,
"name": "daterange",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 12,
"character": 2
}
],
"type": {
"type": "literal",
"value": "daterange"
},
"defaultValue": "\"daterange\""
},
{
"id": 369,
"name": "float4",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 13,
"character": 2
}
],
"type": {
"type": "literal",
"value": "float4"
},
"defaultValue": "\"float4\""
},
{
"id": 370,
"name": "float8",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 14,
"character": 2
}
],
"type": {
"type": "literal",
"value": "float8"
},
"defaultValue": "\"float8\""
},
{
"id": 371,
"name": "int2",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 15,
"character": 2
}
],
"type": {
"type": "literal",
"value": "int2"
},
"defaultValue": "\"int2\""
},
{
"id": 372,
"name": "int4",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 16,
"character": 2
}
],
"type": {
"type": "literal",
"value": "int4"
},
"defaultValue": "\"int4\""
},
{
"id": 373,
"name": "int4range",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 17,
"character": 2
}
],
"type": {
"type": "literal",
"value": "int4range"
},
"defaultValue": "\"int4range\""
},
{
"id": 374,
"name": "int8",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "literal",
"value": "int8"
},
"defaultValue": "\"int8\""
},
{
"id": 375,
"name": "int8range",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 19,
"character": 2
}
],
"type": {
"type": "literal",
"value": "int8range"
},
"defaultValue": "\"int8range\""
},
{
"id": 376,
"name": "json",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 20,
"character": 2
}
],
"type": {
"type": "literal",
"value": "json"
},
"defaultValue": "\"json\""
},
{
"id": 377,
"name": "jsonb",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 21,
"character": 2
}
],
"type": {
"type": "literal",
"value": "jsonb"
},
"defaultValue": "\"jsonb\""
},
{
"id": 378,
"name": "money",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 22,
"character": 2
}
],
"type": {
"type": "literal",
"value": "money"
},
"defaultValue": "\"money\""
},
{
"id": 379,
"name": "numeric",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 23,
"character": 2
}
],
"type": {
"type": "literal",
"value": "numeric"
},
"defaultValue": "\"numeric\""
},
{
"id": 380,
"name": "oid",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 24,
"character": 2
}
],
"type": {
"type": "literal",
"value": "oid"
},
"defaultValue": "\"oid\""
},
{
"id": 381,
"name": "reltime",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 25,
"character": 2
}
],
"type": {
"type": "literal",
"value": "reltime"
},
"defaultValue": "\"reltime\""
},
{
"id": 382,
"name": "text",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 26,
"character": 2
}
],
"type": {
"type": "literal",
"value": "text"
},
"defaultValue": "\"text\""
},
{
"id": 383,
"name": "time",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 27,
"character": 2
}
],
"type": {
"type": "literal",
"value": "time"
},
"defaultValue": "\"time\""
},
{
"id": 384,
"name": "timestamp",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 28,
"character": 2
}
],
"type": {
"type": "literal",
"value": "timestamp"
},
"defaultValue": "\"timestamp\""
},
{
"id": 385,
"name": "timestamptz",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 29,
"character": 2
}
],
"type": {
"type": "literal",
"value": "timestamptz"
},
"defaultValue": "\"timestamptz\""
},
{
"id": 386,
"name": "timetz",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 30,
"character": 2
}
],
"type": {
"type": "literal",
"value": "timetz"
},
"defaultValue": "\"timetz\""
},
{
"id": 387,
"name": "tsrange",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 31,
"character": 2
}
],
"type": {
"type": "literal",
"value": "tsrange"
},
"defaultValue": "\"tsrange\""
},
{
"id": 388,
"name": "tstzrange",
"kind": 16,
"kindString": "Enumeration Member",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 32,
"character": 2
}
],
"type": {
"type": "literal",
"value": "tstzrange"
},
"defaultValue": "\"tstzrange\""
}
],
"groups": [
{
"title": "Enumeration Members",
"kind": 16,
"children": [
365,
366,
367,
368,
369,
370,
371,
372,
373,
374,
375,
376,
377,
378,
379,
380,
381,
382,
383,
384,
385,
386,
387,
388
]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 8,
"character": 12
}
]
},
{
"id": 402,
"name": "convertCell",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 118,
"character": 13
}
],
"signatures": [
{
"id": 403,
"name": "convertCell",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "If the value of the cell is `null`, returns null.\nOtherwise converts the string value to the correct type.",
"tags": [
{
"tag": "example",
"text": "convertCell('bool', 't')\n//=> true"
},
{
"tag": "example",
"text": "convertCell('int8', '10')\n//=> 10"
},
{
"tag": "example",
"text": "convertCell('_int4', '{1,2,3,4}')\n//=> [1,2,3,4]\n"
}
]
},
"parameters": [
{
"id": 404,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A postgres column type"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 405,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RecordValue"
}
}
],
"type": {
"type": "reference",
"name": "RecordValue"
}
}
]
},
{
"id": 389,
"name": "convertChangeData",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 61,
"character": 13
}
],
"signatures": [
{
"id": 390,
"name": "convertChangeData",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Takes an array of columns and an object of string values then converts each string value\nto its mapped type.",
"tags": [
{
"tag": "example",
"text": "convertChangeData([{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], {first_name: 'Paul', age:'33'}, {})\n//=>{ first_name: 'Paul', age: 33 }\n"
}
]
},
"parameters": [
{
"id": 391,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "Columns"
}
},
{
"id": 392,
"name": "record",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {},
"type": {
"type": "reference",
"name": "Record"
}
},
{
"id": 393,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The map of various options that can be applied to the mapper"
},
"type": {
"type": "reflection",
"declaration": {
"id": 394,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 395,
"name": "skipTypes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The array of types that should not be converted\n"
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 64,
"character": 13
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
395
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"name": "Record"
}
}
]
},
{
"id": 396,
"name": "convertColumn",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 88,
"character": 13
}
],
"signatures": [
{
"id": 397,
"name": "convertColumn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Converts the value of an individual column.",
"returns": "Useless information\n",
"tags": [
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], {first_name: 'Paul', age: '33'}, [])\n//=> 33"
},
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], {first_name: 'Paul', age: '33'}, ['int4'])\n//=> \"33\"\n"
}
]
},
"parameters": [
{
"id": 398,
"name": "columnName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The column that you want to convert"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 399,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "Columns"
}
},
{
"id": 400,
"name": "record",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The map of string values"
},
"type": {
"type": "reference",
"name": "Record"
}
},
{
"id": 401,
"name": "skipTypes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "An array of types that should not be converted"
},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"type": {
"type": "reference",
"name": "RecordValue"
}
}
]
},
{
"id": 415,
"name": "toArray",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 206,
"character": 13
}
],
"signatures": [
{
"id": 416,
"name": "toArray",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Converts a Postgres Array into a native JS array",
"tags": [
{
"tag": "example",
"text": "toArray('{}', 'int4')\n//=> []"
},
{
"tag": "example",
"text": "toArray('{\"[2021-01-01,2021-12-31)\",\"(2021-01-01,2021-12-32]\"}', 'daterange')\n//=> ['[2021-01-01,2021-12-31)', '(2021-01-01,2021-12-32]']"
},
{
"tag": "example",
"text": "toArray([1,2,3,4], 'int4')\n//=> [1,2,3,4]\n"
}
]
},
"parameters": [
{
"id": 417,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RecordValue"
}
},
{
"id": 418,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"name": "RecordValue"
}
}
]
},
{
"id": 406,
"name": "toBoolean",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 165,
"character": 13
}
],
"signatures": [
{
"id": 407,
"name": "toBoolean",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 408,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RecordValue"
}
}
],
"type": {
"type": "reference",
"name": "RecordValue"
}
}
]
},
{
"id": 412,
"name": "toJson",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 184,
"character": 13
}
],
"signatures": [
{
"id": 413,
"name": "toJson",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 414,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RecordValue"
}
}
],
"type": {
"type": "reference",
"name": "RecordValue"
}
}
]
},
{
"id": 409,
"name": "toNumber",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 175,
"character": 13
}
],
"signatures": [
{
"id": 410,
"name": "toNumber",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 411,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RecordValue"
}
}
],
"type": {
"type": "reference",
"name": "RecordValue"
}
}
]
},
{
"id": 419,
"name": "toTimestampString",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 241,
"character": 13
}
],
"signatures": [
{
"id": 420,
"name": "toTimestampString",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Fixes timestamp to be ISO-8601. Swaps the space between the date and time for a 'T'\nSee https://github.com/supabase/supabase/issues/18",
"tags": [
{
"tag": "example",
"text": "toTimestampString('2019-09-10 00:00:00')\n//=> '2019-09-10T00:00:00'\n"
}
]
},
"parameters": [
{
"id": 421,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RecordValue"
}
}
],
"type": {
"type": "reference",
"name": "RecordValue"
}
}
]
}
],
"groups": [
{
"title": "Enumerations",
"kind": 8,
"children": [
364
]
},
{
"title": "Functions",
"kind": 64,
"children": [
402,
389,
396,
415,
406,
412,
409,
419
]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 8,
"character": 0
}
]
},
{
"id": 142,
"name": "RealtimeChannel",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 153,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 25,
"character": 2
}
],
"signatures": [
{
"id": 154,
"name": "new RealtimeChannel",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 155,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 156,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 157,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 158,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 159,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 160,
"name": "socket",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
}
],
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
}
]
},
{
"id": 161,
"name": "bindings",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 9,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 162,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 163,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 164,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reflection",
"declaration": {
"id": 165,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 171,
"name": "callback",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 13,
"character": 6
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 167,
"name": "filter",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 12,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 168,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 12,
"character": 14
}
],
"indexSignature": {
"id": 169,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 170,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 172,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 14,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 166,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 11,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
171,
167,
172,
166
]
}
],
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 10,
"character": 19
}
]
}
}
}
}
}
},
"defaultValue": "{}"
},
{
"id": 176,
"name": "joinPush",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 20,
"character": 2
}
],
"type": {
"type": "reference",
"name": "default"
}
},
{
"id": 175,
"name": "joinedOnce",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 19,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
},
{
"id": 181,
"name": "params",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 182,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 183,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 184,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 179,
"name": "presence",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 23,
"character": 2
}
],
"type": {
"type": "reference",
"id": 300,
"name": "default"
}
},
{
"id": 178,
"name": "pushBuffer",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 22,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "default"
}
},
"defaultValue": "[]"
},
{
"id": 177,
"name": "rejoinTimer",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 21,
"character": 2
}
],
"type": {
"type": "reference",
"name": "default"
}
},
{
"id": 185,
"name": "socket",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true
},
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
},
{
"id": 174,
"name": "state",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "reference",
"name": "CHANNEL_STATES"
},
"defaultValue": "CHANNEL_STATES.closed"
},
{
"id": 173,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 17,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 180,
"name": "topic",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 231,
"name": "canPush",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 282,
"character": 2
}
],
"signatures": [
{
"id": 232,
"name": "canPush",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns `true` if the socket is connected and the channel has been joined."
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 282,
"name": "isClosed",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 478,
"character": 2
}
],
"signatures": [
{
"id": 283,
"name": "isClosed",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 284,
"name": "isErrored",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 481,
"character": 2
}
],
"signatures": [
{
"id": 285,
"name": "isErrored",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 286,
"name": "isJoined",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 484,
"character": 2
}
],
"signatures": [
{
"id": 287,
"name": "isJoined",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 288,
"name": "isJoining",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 487,
"character": 2
}
],
"signatures": [
{
"id": 289,
"name": "isJoining",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 290,
"name": "isLeaving",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 490,
"character": 2
}
],
"signatures": [
{
"id": 291,
"name": "isLeaving",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 266,
"name": "isMember",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 385,
"character": 2
}
],
"signatures": [
{
"id": 267,
"name": "isMember",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 268,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 269,
"name": "joinRef",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 389,
"character": 2
}
],
"signatures": [
{
"id": 270,
"name": "joinRef",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 224,
"name": "off",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 267,
"character": 2
}
],
"signatures": [
{
"id": 225,
"name": "off",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 226,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 227,
"name": "filter",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 228,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 229,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 230,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
}
],
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
}
]
},
{
"id": 216,
"name": "on",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 249,
"character": 2
}
],
"signatures": [
{
"id": 217,
"name": "on",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"returns": "\n"
},
"parameters": [
{
"id": 218,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "\"postgres_changes\" is the only type supported at this time"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 219,
"name": "filter",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "An object with an event property and a schema property. Event property can be `*`, `insert`, `create`, `update`, or `delete`."
},
"type": {
"type": "reflection",
"declaration": {
"id": 220,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 221,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 222,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 223,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A callback function that will be called when the channel receives a message."
},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
],
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
}
]
},
{
"id": 210,
"name": "onClose",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 231,
"character": 2
}
],
"signatures": [
{
"id": 211,
"name": "onClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Registers a callback that will be executed when the channel closes."
},
"parameters": [
{
"id": 212,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 213,
"name": "onError",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 238,
"character": 2
}
],
"signatures": [
{
"id": 214,
"name": "onError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Registers a callback that will be executed when the channel encounteres an error."
},
"parameters": [
{
"id": 215,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 261,
"name": "onMessage",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 381,
"character": 2
}
],
"signatures": [
{
"id": 262,
"name": "onMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Overridable message hook",
"text": "Receives all events for specialized message handling before dispatching to the channel callbacks.\nMust return the payload, modified or unmodified.\n"
},
"parameters": [
{
"id": 263,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 264,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 265,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
},
{
"id": 192,
"name": "presenceState",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 198,
"character": 2
}
],
"signatures": [
{
"id": 193,
"name": "presenceState",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"name": "PresenceState"
}
}
]
},
{
"id": 233,
"name": "push",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 286,
"character": 2
}
],
"signatures": [
{
"id": 234,
"name": "push",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 235,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 236,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 237,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 238,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 239,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 240,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"name": "default"
}
}
]
},
{
"id": 271,
"name": "rejoin",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 393,
"character": 2
}
],
"signatures": [
{
"id": 272,
"name": "rejoin",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 273,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 186,
"name": "rejoinUntilConnected",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 83,
"character": 2
}
],
"signatures": [
{
"id": 187,
"name": "rejoinUntilConnected",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 279,
"name": "replyEventName",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 474,
"character": 2
}
],
"signatures": [
{
"id": 280,
"name": "replyEventName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 281,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 241,
"name": "send",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 301,
"character": 2
}
],
"signatures": [
{
"id": 242,
"name": "send",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 243,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 244,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 245,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 302,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
245
]
}
],
"indexSignature": {
"id": 246,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 247,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 248,
"name": "opts",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 249,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 250,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 251,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "rate limited"
},
{
"type": "literal",
"value": "timed out"
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 188,
"name": "subscribe",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 90,
"character": 2
}
],
"signatures": [
{
"id": 189,
"name": "subscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 190,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 191,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 194,
"name": "track",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 202,
"character": 8
}
],
"signatures": [
{
"id": 195,
"name": "track",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 196,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 197,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 198,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 199,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 200,
"name": "opts",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 201,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 202,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 203,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "rate limited"
},
{
"type": "literal",
"value": "timed out"
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 274,
"name": "trigger",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 402,
"character": 2
}
],
"signatures": [
{
"id": 275,
"name": "trigger",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 276,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 277,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 278,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 258,
"name": "unsubscribe",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 341,
"character": 2
}
],
"signatures": [
{
"id": 259,
"name": "unsubscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Leaves the channel.",
"text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n"
},
"parameters": [
{
"id": 260,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": "error"
},
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "timed out"
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 204,
"name": "untrack",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 216,
"character": 8
}
],
"signatures": [
{
"id": 205,
"name": "untrack",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 206,
"name": "opts",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 207,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 208,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 209,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "rate limited"
},
{
"type": "literal",
"value": "timed out"
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 252,
"name": "updateJoinPayload",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 328,
"character": 2
}
],
"signatures": [
{
"id": 253,
"name": "updateJoinPayload",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 254,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 255,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 256,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 257,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
153
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
161,
176,
175,
181,
179,
178,
177,
185,
174,
173,
180
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
231,
282,
284,
286,
288,
290,
266,
269,
224,
216,
210,
213,
261,
192,
233,
271,
186,
279,
241,
188,
194,
274,
258,
204,
252
]
}
],
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 8,
"character": 21
}
]
},
{
"id": 1,
"name": "RealtimeClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 2,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 89,
"character": 2
}
],
"signatures": [
{
"id": 3,
"name": "new RealtimeClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"comment": {
"shortText": "Initializes the Socket."
},
"parameters": [
{
"id": 4,
"name": "endPoint",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 5,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 125,
"name": "Options"
}
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
}
]
},
{
"id": 6,
"name": "accessToken",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 42,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "null"
},
{
"id": 7,
"name": "channels",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 43,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 142,
"name": "default"
}
},
"defaultValue": "[]"
},
{
"id": 28,
"name": "conn",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 58,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"qualifiedName": "WebSocket",
"package": "typescript",
"name": "WebSocket"
}
]
},
"defaultValue": "null"
},
{
"id": 26,
"name": "decode",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 56,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 25,
"name": "encode",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 55,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 8,
"name": "endPoint",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 44,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "''"
},
{
"id": 37,
"name": "eventsPerSecondLimitMs",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 72,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "100"
},
{
"id": 9,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 10,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 11,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 12,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
},
"defaultValue": "DEFAULT_HEADERS"
},
{
"id": 19,
"name": "heartbeatIntervalMs",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "30000"
},
{
"id": 20,
"name": "heartbeatTimer",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"qualifiedName": "global.NodeJS.Timer",
"package": "@types/node",
"name": "Timer"
}
]
},
"defaultValue": "undefined"
},
{
"id": 38,
"name": "inThrottle",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 73,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
},
{
"id": 24,
"name": "logger",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 54,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
},
"defaultValue": "noop"
},
{
"id": 13,
"name": "params",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 46,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 14,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 15,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 16,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 21,
"name": "pendingHeartbeatRef",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 51,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "null"
},
{
"id": 27,
"name": "reconnectAfterMs",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 57,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 23,
"name": "reconnectTimer",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 53,
"character": 2
}
],
"type": {
"type": "reference",
"name": "default"
}
},
{
"id": 22,
"name": "ref",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 52,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 29,
"name": "sendBuffer",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 59,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
"defaultValue": "[]"
},
{
"id": 30,
"name": "serializer",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 60,
"character": 2
}
],
"type": {
"type": "reference",
"name": "default"
},
"defaultValue": "..."
},
{
"id": 31,
"name": "stateChangeCallbacks",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 61,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 32,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 34,
"name": "close",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 63,
"character": 4
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
},
{
"id": 35,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 64,
"character": 4
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
},
{
"id": 36,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 65,
"character": 4
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
},
{
"id": 33,
"name": "open",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 62,
"character": 4
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
34,
35,
36,
33
]
}
]
}
},
"defaultValue": "..."
},
{
"id": 17,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 47,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "DEFAULT_TIMEOUT"
},
{
"id": 18,
"name": "transport",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 48,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "w3cwebsocket"
},
{
"id": 76,
"name": "channel",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 278,
"character": 2
}
],
"signatures": [
{
"id": 77,
"name": "channel",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 78,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 79,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "ChannelParams"
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
}
]
},
{
"id": 39,
"name": "connect",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 126,
"character": 2
}
],
"signatures": [
{
"id": 40,
"name": "connect",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Connects the socket, unless already connected."
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 69,
"name": "connectionState",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 247,
"character": 2
}
],
"signatures": [
{
"id": 70,
"name": "connectionState",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the current state of the socket."
},
"type": {
"type": "reference",
"name": "CONNECTION_STATE"
}
}
]
},
{
"id": 41,
"name": "disconnect",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 148,
"character": 2
}
],
"signatures": [
{
"id": 42,
"name": "disconnect",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Disconnects the socket."
},
"parameters": [
{
"id": 43,
"name": "code",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A numeric status code to send on disconnect."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 44,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom reason for the disconnect.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 88,
"name": "endPointURL",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 345,
"character": 2
}
],
"signatures": [
{
"id": 89,
"name": "endPointURL",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the URL of the websocket."
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 45,
"name": "getChannels",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 163,
"character": 2
}
],
"signatures": [
{
"id": 46,
"name": "getChannels",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 142,
"name": "default"
}
}
}
]
},
{
"id": 71,
"name": "isConnected",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 263,
"character": 2
}
],
"signatures": [
{
"id": 72,
"name": "isConnected",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Retuns `true` is the connection is open."
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 95,
"name": "leaveOpenTopic",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 386,
"character": 2
}
],
"signatures": [
{
"id": 96,
"name": "leaveOpenTopic",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Unsubscribe from channels with the specified topic."
},
"parameters": [
{
"id": 97,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 52,
"name": "log",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 192,
"character": 2
}
],
"signatures": [
{
"id": 53,
"name": "log",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs the message.",
"text": "For customized logging, `this.logger` can be overriden.\n"
},
"parameters": [
{
"id": 54,
"name": "kind",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 55,
"name": "msg",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 56,
"name": "data",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 90,
"name": "makeRef",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 355,
"character": 2
}
],
"signatures": [
{
"id": 91,
"name": "makeRef",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return the next message ref, accounting for overflows"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 60,
"name": "onClose",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 216,
"character": 2
}
],
"signatures": [
{
"id": 61,
"name": "onClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Registers a callback for connection state change events.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen(() => console.log(\"Socket closed.\"))\n"
}
]
},
"parameters": [
{
"id": 62,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 83,
"name": "onConnMessage",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 315,
"character": 2
}
],
"signatures": [
{
"id": 84,
"name": "onConnMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 85,
"name": "rawMessage",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 86,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 87,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 315,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
87
]
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 63,
"name": "onError",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 228,
"character": 2
}
],
"signatures": [
{
"id": 64,
"name": "onError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Registers a callback for connection state change events.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen((error) => console.log(\"An error occurred\"))\n"
}
]
},
"parameters": [
{
"id": 65,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 66,
"name": "onMessage",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 240,
"character": 2
}
],
"signatures": [
{
"id": 67,
"name": "onMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Calls a function any time a message is received.",
"tags": [
{
"tag": "example",
"text": "\n socket.onMessage((message) => console.log(message))\n"
}
]
},
"parameters": [
{
"id": 68,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 57,
"name": "onOpen",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 204,
"character": 2
}
],
"signatures": [
{
"id": 58,
"name": "onOpen",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Registers a callback for connection state change event.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen(() => console.log(\"Socket opened.\"))\n"
}
]
},
"parameters": [
{
"id": 59,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 80,
"name": "push",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 293,
"character": 2
}
],
"signatures": [
{
"id": 81,
"name": "push",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Push out a message if the socket is connected.",
"text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n"
},
"parameters": [
{
"id": 82,
"name": "data",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "Message"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "void"
},
{
"type": "literal",
"value": "rate limited"
}
]
}
}
]
},
{
"id": 73,
"name": "remove",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 272,
"character": 2
}
],
"signatures": [
{
"id": 74,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes a subscription from the socket."
},
"parameters": [
{
"id": 75,
"name": "channel",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "An open subscription.\n"
},
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 50,
"name": "removeAllChannels",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 178,
"character": 2
}
],
"signatures": [
{
"id": 51,
"name": "removeAllChannels",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "array",
"elementType": {
"type": "union",
"types": [
{
"type": "literal",
"value": "error"
},
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "timed out"
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 47,
"name": "removeChannel",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 167,
"character": 2
}
],
"signatures": [
{
"id": 48,
"name": "removeChannel",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 49,
"name": "channel",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "literal",
"value": "error"
},
{
"type": "literal",
"value": "ok"
},
{
"type": "literal",
"value": "timed out"
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 92,
"name": "setAuth",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 371,
"character": 2
}
],
"signatures": [
{
"id": 93,
"name": "setAuth",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS."
},
"parameters": [
{
"id": 94,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A JWT string.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
2
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
6,
7,
28,
26,
25,
8,
37,
9,
19,
20,
38,
24,
13,
21,
27,
23,
22,
29,
30,
31,
17,
18
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
76,
39,
69,
41,
88,
45,
71,
95,
52,
90,
60,
83,
63,
66,
57,
80,
73,
50,
47,
92
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 41,
"character": 21
}
]
},
{
"id": 300,
"name": "RealtimePresence",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 332,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 64,
"character": 2
}
],
"signatures": [
{
"id": 333,
"name": "new RealtimePresence",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"comment": {
"shortText": "Initializes the Presence."
},
"parameters": [
{
"id": 334,
"name": "channel",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The RealtimeChannel"
},
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
},
{
"id": 335,
"name": "opts",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n"
},
"type": {
"type": "reference",
"qualifiedName": "PresenceOpts",
"package": "@types/phoenix",
"name": "PresenceOpts"
}
}
],
"type": {
"type": "reference",
"id": 300,
"name": "default"
}
}
]
},
{
"id": 339,
"name": "caller",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 47,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 340,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 341,
"name": "onJoin",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 48,
"character": 4
}
],
"type": {
"type": "reference",
"qualifiedName": "PresenceOnJoinCallback",
"package": "@types/phoenix",
"name": "PresenceOnJoinCallback"
}
},
{
"id": 342,
"name": "onLeave",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 49,
"character": 4
}
],
"type": {
"type": "reference",
"qualifiedName": "PresenceOnLeaveCallback",
"package": "@types/phoenix",
"name": "PresenceOnLeaveCallback"
}
},
{
"id": 343,
"name": "onSync",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 50,
"character": 4
}
],
"signatures": [
{
"id": 344,
"name": "onSync",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
341,
342
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
343
]
}
]
}
},
"defaultValue": "..."
},
{
"id": 345,
"name": "channel",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true
},
"type": {
"type": "reference",
"id": 142,
"name": "default"
}
},
{
"id": 338,
"name": "joinRef",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 46,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "null"
},
{
"id": 337,
"name": "pendingDiffs",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "RawPresenceDiff"
}
},
"defaultValue": "[]"
},
{
"id": 336,
"name": "state",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 44,
"character": 2
}
],
"type": {
"type": "reference",
"name": "PresenceState"
},
"defaultValue": "{}"
},
{
"id": 357,
"name": "list",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 345,
"character": 2
}
],
"signatures": [
{
"id": 358,
"name": "list",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"typeParameter": [
{
"id": 359,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {},
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"parameters": [
{
"id": 360,
"name": "by",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 359,
"name": "T"
}
],
"name": "PresenceChooser"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 359,
"name": "T"
}
}
}
]
},
{
"id": 346,
"name": "onJoin",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 333,
"character": 2
}
],
"signatures": [
{
"id": 347,
"name": "onJoin",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 348,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "PresenceOnJoinCallback",
"package": "@types/phoenix",
"name": "PresenceOnJoinCallback"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 349,
"name": "onLeave",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 337,
"character": 2
}
],
"signatures": [
{
"id": 350,
"name": "onLeave",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 351,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "PresenceOnLeaveCallback",
"package": "@types/phoenix",
"name": "PresenceOnLeaveCallback"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 352,
"name": "onSync",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 341,
"character": 2
}
],
"signatures": [
{
"id": 353,
"name": "onSync",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 354,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 355,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 356,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 313,
"name": "list",
"kind": 2048,
"kindString": "Method",
"flags": {
"isStatic": true
},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 263,
"character": 9
}
],
"signatures": [
{
"id": 314,
"name": "list",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the array of presences, with selected metadata."
},
"typeParameter": [
{
"id": 315,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {},
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"parameters": [
{
"id": 316,
"name": "presences",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "PresenceState"
}
},
{
"id": 317,
"name": "chooser",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 315,
"name": "T"
}
],
"name": "PresenceChooser"
}
]
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 315,
"name": "T"
}
}
}
]
},
{
"id": 307,
"name": "syncDiff",
"kind": 2048,
"kindString": "Method",
"flags": {
"isStatic": true
},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 201,
"character": 9
}
],
"signatures": [
{
"id": 308,
"name": "syncDiff",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Used to sync a diff of presence join and leave events from the\nserver, as they happen.",
"text": "Like `syncState`, `syncDiff` accepts optional `onJoin` and\n`onLeave` callbacks to react to a user joining or leaving from a\ndevice.\n"
},
"parameters": [
{
"id": 309,
"name": "state",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "PresenceState"
}
},
{
"id": 310,
"name": "diff",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "PresenceDiff"
},
{
"type": "reference",
"name": "RawPresenceDiff"
}
]
}
},
{
"id": 311,
"name": "onJoin",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "PresenceOnJoinCallback",
"package": "@types/phoenix",
"name": "PresenceOnJoinCallback"
}
},
{
"id": 312,
"name": "onLeave",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "PresenceOnLeaveCallback",
"package": "@types/phoenix",
"name": "PresenceOnLeaveCallback"
}
}
],
"type": {
"type": "reference",
"name": "PresenceState"
}
}
]
},
{
"id": 301,
"name": "syncState",
"kind": 2048,
"kindString": "Method",
"flags": {
"isStatic": true
},
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 144,
"character": 9
}
],
"signatures": [
{
"id": 302,
"name": "syncState",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Used to sync the list of presences on the server with the\nclient's state.",
"text": "An optional `onJoin` and `onLeave` callback can be provided to\nreact to changes in the client's local presences across\ndisconnects and reconnects with the server.\n"
},
"parameters": [
{
"id": 303,
"name": "currentState",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "PresenceState"
}
},
{
"id": 304,
"name": "newState",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "PresenceState"
},
{
"type": "reference",
"name": "RawPresenceState"
}
]
}
},
{
"id": 305,
"name": "onJoin",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "PresenceOnJoinCallback",
"package": "@types/phoenix",
"name": "PresenceOnJoinCallback"
}
},
{
"id": 306,
"name": "onLeave",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "PresenceOnLeaveCallback",
"package": "@types/phoenix",
"name": "PresenceOnLeaveCallback"
}
}
],
"type": {
"type": "reference",
"name": "PresenceState"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
332
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
339,
345,
338,
337,
336
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
357,
346,
349,
352,
313,
307,
301
]
}
],
"sources": [
{
"fileName": "RealtimePresence.ts",
"line": 43,
"character": 21
}
]
},
{
"id": 125,
"name": "RealtimeClientOptions",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 16,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 126,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 132,
"name": "decode",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 22,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 131,
"name": "encode",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 21,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 134,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 24,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 135,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 24,
"character": 12
}
],
"indexSignature": {
"id": 136,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 137,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 129,
"name": "heartbeatIntervalMs",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 19,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 130,
"name": "logger",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 20,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 138,
"name": "params",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 25,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 139,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 25,
"character": 11
}
],
"indexSignature": {
"id": 140,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 141,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 133,
"name": "reconnectAfterMs",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 23,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "Function",
"package": "typescript",
"name": "Function"
}
},
{
"id": 128,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 127,
"name": "transport",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 17,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "WebSocket",
"package": "typescript",
"name": "WebSocket"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
132,
131,
134,
129,
130,
138,
133,
128,
127
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 16,
"character": 22
}
]
}
}
}
],
"groups": [
{
"title": "Namespaces",
"kind": 4,
"children": [
363
]
},
{
"title": "Classes",
"kind": 128,
"children": [
142,
1,
300
]
},
{
"title": "Type Aliases",
"kind": 4194304,
"children": [
125
]
}
],
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
}
Reference in New Issue View Git Blame Copy Permalink