dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-10 03:45:06 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
718d5665222fc8aabe208357474162ff87f2a0c7
supabase/web/spec/combined.json
T
Copple a788003648 Documentation for the new DX (#253) 
## What kind of change does this PR introduce?

Updates the docs with the new developer experience: https://deploy-preview-253--supabase.netlify.app/docs

- Documents the new Auth using `gotrue-js`
- Fixes #179 
- Fixes OAuth links https://github.com/supabase/supabase/issues/241#issuecomment-705632335 
- [x] Add docs on Policies

## Additional context

Related PR on `supabase-js` https://github.com/supabase/supabase-js/pull/50

* Updates the docs for the new Auth DX.

* docs: adds docs for subscribing to rows

* Updates all the reads

* Updates all the docs with the new format

* docs: Replaces all { error, data} with data first, because I subjectively think it looks better

* Adds some of the breaking changes to a blog post

* Adds headings

* removes the blog post since it is now in notion

* Adds the Oauth changes

* removes recharts because we no longer use it

* Adds basic structure for GoTrue ref

* Adds styles for the api reference docs

* Adds more generated docs

* Downloads the files to work locally

* Adds a supabase generator

* Moves some of the guides into the "tools" folder

* Re-shuffles some of the pages around

* Generated everythign related to the Supabase Client

* Refactors and categorieses the pages

* Changes the names to be more readable

* Migrates almost all of the filters into the API reference

* Moves most of the stored procedure filters

* Adds realtime-js to the mix

* More desciptive titles

* Moves all the generated docs to the docs folder

* Moves over some of the data manipulators

* Extracts most of the client functionality to the API ref

* Adds more detail to the guides

* Removes the reference to the emulator

* Adds the supabase 1.0 blog post

* Adds a redirects for netlify

* chore: Updates packages

* Updates broken links

* Adding docs for the server

* Adds comments to gotrue and pgapi

* Adds a twitter icon to our navbar

* Updates the auth with the new user and session return values

* Updates the sponsors

* Styles for cards

* Adds a default value to all of the Tabs
2020-11-02 11:08:02 +08:00

28458 lines
1.0 MiB
Plaintext
Raw Blame History

{
"name": "Combined Specs",
"children": [
{
"id": 0,
"name": "@supabase/supabase-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 189,
"name": "\"SupabaseClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/SupabaseClient.ts",
"children": [
{
"id": 190,
"name": "SupabaseClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Supabase Client.",
"text": "An isomorphic Javascript client for interacting with Postgres.\n"
},
"children": [
{
"id": 197,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"signatures": [
{
"id": 200,
"name": "new SupabaseClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 201,
"name": "supabaseUrl",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 202,
"name": "supabaseKey",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 203,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 5,
"name": "SupabaseClientOptions"
}
}
],
"type": {
"type": "reference",
"id": 190,
"name": "SupabaseClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 30,
"character": 36
}
]
},
{
"id": 191,
"name": "auth",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies."
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 25,
"character": 6
}
],
"type": {
"type": "reference",
"id": 25,
"name": "SupabaseAuthClient"
}
},
{
"id": 195,
"name": "authUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 29,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 196,
"name": "realtime",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 30,
"character": 20
}
],
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 194,
"name": "realtimeUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 28,
"character": 23
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 193,
"name": "restUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 27,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 192,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 26,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 199,
"name": "supabaseKey",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard."
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 44,
"character": 25
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 198,
"name": "supabaseUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard."
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 43,
"character": 25
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 230,
"name": "_closeChannel",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 231,
"name": "_closeChannel",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 232,
"name": "subscription",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 155,
"character": 23
}
]
},
{
"id": 225,
"name": "_getAuthHeaders",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 226,
"name": "_getAuthHeaders",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 227,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 228,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 229,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 147,
"character": 28
}
]
}
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 147,
"character": 25
}
]
},
{
"id": 223,
"name": "_initPostgRESTClient",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 224,
"name": "_initPostgRESTClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "PostgrestClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 140,
"character": 30
}
]
},
{
"id": 221,
"name": "_initRealtimeClient",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 222,
"name": "_initRealtimeClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "RealtimeClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 134,
"character": 29
}
]
},
{
"id": 218,
"name": "_initSupabaseAuthClient",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 219,
"name": "_initSupabaseAuthClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 220,
"name": "settings",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 5,
"name": "SupabaseClientOptions"
}
}
],
"type": {
"type": "reference",
"id": 25,
"name": "SupabaseAuthClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 121,
"character": 33
}
]
},
{
"id": 204,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 205,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a table operation."
},
"typeParameter": [
{
"id": 206,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 207,
"name": "table",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The table name to operate on.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 131,
"typeArguments": [
{
"type": "typeParameter",
"name": "T",
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"name": "SupabaseQueryBuilder"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 70,
"character": 6
}
]
},
{
"id": 216,
"name": "getSubscriptions",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 217,
"name": "getSubscriptions",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns an array of all your subscriptions."
},
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 117,
"character": 18
}
]
},
{
"id": 213,
"name": "removeSubscription",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 214,
"name": "removeSubscription",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes an active subscription and returns the number of open connections."
},
"parameters": [
{
"id": 215,
"name": "subscription",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The subscription you want to remove.\n"
},
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 96,
"character": 20
}
]
},
{
"id": 208,
"name": "rpc",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 209,
"name": "rpc",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a stored procedure call."
},
"typeParameter": [
{
"id": 210,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 211,
"name": "fn",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The function name to call."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 212,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The parameters to pass to the function call.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "unknown",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 86,
"character": 5
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
197
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
191,
195,
196,
194,
193,
192,
199,
198
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
230,
225,
223,
221,
218,
204,
216,
213,
208
]
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 21,
"character": 35
}
]
},
{
"id": 233,
"name": "DEFAULT_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 235,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 10,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 237,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 12,
"character": 20
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 238,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 13,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 239,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
},
"defaultValue": "DEFAULT_HEADERS"
},
{
"id": 236,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 11,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 234,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 9,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"public\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
235,
237,
238,
236,
234
]
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 8,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
190
]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [
233
]
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 240,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/index.ts",
"children": [
{
"id": 241,
"name": "createClient",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "Creates a new Supabase Client."
},
"signatures": [
{
"id": 242,
"name": "createClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new Supabase Client."
},
"parameters": [
{
"id": 243,
"name": "supabaseUrl",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 244,
"name": "supabaseKey",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 245,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 5,
"name": "SupabaseClientOptions"
}
}
],
"type": {
"type": "reference",
"id": 190,
"name": "SupabaseClient"
}
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 7,
"character": 18
}
]
}
],
"groups": [
{
"title": "Functions",
"kind": 64,
"children": [
241
]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 24,
"name": "\"lib/SupabaseAuthClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/lib/SupabaseAuthClient.ts",
"children": [
{
"id": 25,
"name": "SupabaseAuthClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 26,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 27,
"name": "new SupabaseAuthClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 28,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 29,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 36,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 8,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 35,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 7,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 31,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 6,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 32,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 33,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 34,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 38,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 10,
"character": 16
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 37,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 9,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 30,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 5,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
36,
35,
31,
38,
37,
30
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 4,
"character": 22
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 25,
"name": "SupabaseAuthClient"
},
"overwrites": {
"type": "reference",
"name": "GoTrueClient.__constructor"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 3,
"character": 54
}
],
"overwrites": {
"type": "reference",
"name": "GoTrueClient.__constructor"
}
},
{
"id": 41,
"name": "api",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 12,
"character": 17
}
],
"type": {
"type": "reference",
"name": "GoTrueApi"
},
"inheritedFrom": {
"type": "reference",
"id": 41,
"name": "GoTrueClient.api"
}
},
{
"id": 42,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 13,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"id": 42,
"name": "GoTrueClient.autoRefreshToken"
}
},
{
"id": 40,
"name": "currentSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The session object for the currently logged in user or null."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 11,
"character": 28
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "GoTrueClient.currentSession"
}
},
{
"id": 39,
"name": "currentUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The currently logged in user or null."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 7,
"character": 25
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 39,
"name": "GoTrueClient.currentUser"
}
},
{
"id": 44,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 15,
"character": 26
}
],
"type": {
"type": "reference",
"name": "Storage"
},
"inheritedFrom": {
"type": "reference",
"id": 44,
"name": "GoTrueClient.localStorage"
}
},
{
"id": 43,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 14,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"id": 43,
"name": "GoTrueClient.persistSession"
}
},
{
"id": 45,
"name": "stateChangeEmmitters",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 16,
"character": 34
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"name": "Subscription"
}
],
"name": "Map"
},
"inheritedFrom": {
"type": "reference",
"id": 45,
"name": "GoTrueClient.stateChangeEmmitters"
}
},
{
"id": 93,
"name": "getSessionFromUrl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 94,
"name": "getSessionFromUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Gets the session data from a URL string"
},
"parameters": [
{
"id": 95,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 96,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 97,
"name": "storeSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Optionally store the session in the browser\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 104,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
97
]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 98,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 99,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 106,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 100,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 107,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
99,
100
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 105,
"character": 16
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 93,
"name": "GoTrueClient.getSessionFromUrl"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 103,
"character": 21
}
],
"inheritedFrom": {
"type": "reference",
"id": 93,
"name": "GoTrueClient.getSessionFromUrl"
}
},
{
"id": 105,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 106,
"name": "onAuthStateChange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Receive a notification every time an auth event happens.",
"returns": "A subscription object which can be used to unsubcribe itself.\n"
},
"parameters": [
{
"id": 107,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 108,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 109,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 110,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "AuthChangeEvent"
}
},
{
"id": 111,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 119,
"character": 31
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 112,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 113,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 120,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Subscription"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 114,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 121,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
113,
114
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 119,
"character": 91
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 105,
"name": "GoTrueClient.onAuthStateChange"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 119,
"character": 21
}
],
"inheritedFrom": {
"type": "reference",
"id": 105,
"name": "GoTrueClient.onAuthStateChange"
}
},
{
"id": 80,
"name": "refreshSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 81,
"name": "refreshSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Force refreshes the session including the user data in case it was updated in a different session."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 82,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 83,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 87,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 85,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 89,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 84,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 88,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
83,
85,
84
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 86,
"character": 30
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 80,
"name": "GoTrueClient.refreshSession"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 86,
"character": 18
}
],
"inheritedFrom": {
"type": "reference",
"id": 80,
"name": "GoTrueClient.refreshSession"
}
},
{
"id": 75,
"name": "session",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 76,
"name": "session",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the session data, if there is an active session."
},
"type": {
"type": "reflection",
"declaration": {
"id": 77,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 78,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 80,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 79,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 81,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
78,
79
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 79,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 75,
"name": "GoTrueClient.session"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 79,
"character": 11
}
],
"inheritedFrom": {
"type": "reference",
"id": 75,
"name": "GoTrueClient.session"
}
},
{
"id": 56,
"name": "signIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 57,
"name": "signIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Log in an existing user, or login via a third-party provider."
},
"parameters": [
{
"id": 58,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The user login details."
},
"type": {
"type": "reflection",
"declaration": {
"id": 59,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 60,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 58,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 61,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The user's password."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 59,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 62,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "One of the providers supported by GoTrue.\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 60,
"character": 16
}
],
"type": {
"type": "reference",
"name": "Provider"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
60,
61,
62
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 57,
"character": 23
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 63,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 64,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 62,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 68,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 66,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 66,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 64,
"character": 16
}
],
"type": {
"type": "reference",
"name": "Provider"
}
},
{
"id": 67,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 65,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 65,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 63,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
64,
68,
66,
67,
65
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 61,
"character": 16
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 56,
"name": "GoTrueClient.signIn"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 57,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 56,
"name": "GoTrueClient.signIn"
}
},
{
"id": 101,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 102,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Signs out the current user, if there is a logged in user."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 103,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 104,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 113,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
104
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 112,
"character": 23
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 101,
"name": "GoTrueClient.signOut"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 112,
"character": 11
}
],
"inheritedFrom": {
"type": "reference",
"id": 101,
"name": "GoTrueClient.signOut"
}
},
{
"id": 46,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 47,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new user."
},
"parameters": [
{
"id": 48,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The user login details."
},
"type": {
"type": "reflection",
"declaration": {
"id": 49,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 50,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 43,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 51,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's password.\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 44,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
50,
51
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 42,
"character": 23
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 52,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 53,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 46,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 55,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 48,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 54,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 47,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
53,
55,
54
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 45,
"character": 16
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 46,
"name": "GoTrueClient.signUp"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 42,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 46,
"name": "GoTrueClient.signUp"
}
},
{
"id": 86,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 87,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Updates user data, if there is a logged in user."
},
"parameters": [
{
"id": 88,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 89,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 90,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 95,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 92,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 97,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 91,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 96,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
90,
92,
91
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 94,
"character": 48
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 86,
"name": "GoTrueClient.update"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 94,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 86,
"name": "GoTrueClient.update"
}
},
{
"id": 69,
"name": "user",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 70,
"name": "user",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the user data, if there is a logged in user."
},
"type": {
"type": "reflection",
"declaration": {
"id": 71,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 72,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 72,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 74,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 74,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 73,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 73,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
72,
74,
73
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 71,
"character": 11
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 69,
"name": "GoTrueClient.user"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 71,
"character": 8
}
],
"inheritedFrom": {
"type": "reference",
"id": 69,
"name": "GoTrueClient.user"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
26
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
41,
42,
40,
39,
44,
43,
45
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
93,
105,
80,
75,
56,
101,
46,
86,
69
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 3,
"character": 31
}
],
"extendedTypes": [
{
"type": "reference",
"name": "GoTrueClient"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
25
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 130,
"name": "\"lib/SupabaseQueryBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/lib/SupabaseQueryBuilder.ts",
"children": [
{
"id": 131,
"name": "SupabaseQueryBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 132,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 135,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 136,
"name": "new SupabaseQueryBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 137,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 138,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 139,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 140,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 13,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 141,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 142,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 143,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 145,
"name": "realtime",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 15,
"character": 14
}
],
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 144,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 146,
"name": "table",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 16,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
140,
145,
144,
146
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 11,
"character": 16
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 131,
"name": "SupabaseQueryBuilder"
},
"overwrites": {
"type": "reference",
"name": "PostgrestQueryBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 8,
"character": 35
}
],
"overwrites": {
"type": "reference",
"name": "PostgrestQueryBuilder.__constructor"
}
},
{
"id": 134,
"name": "_realtime",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPrivate": true,
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 8,
"character": 19
}
],
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 133,
"name": "_subscription",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPrivate": true,
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 7,
"character": 23
}
],
"type": {
"type": "reference",
"id": 116,
"name": "SupabaseRealtimeClient"
}
},
{
"id": 176,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 38,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 176,
"name": "PostgrestBuilder.body"
}
},
{
"id": 171,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 34,
"character": 21
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 172,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 173,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 174,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 34,
"character": 22
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 171,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 169,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 32,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 169,
"name": "PostgrestBuilder.method"
}
},
{
"id": 175,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 37,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 175,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 170,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 33,
"character": 17
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 170,
"name": "PostgrestBuilder.url"
}
},
{
"id": 167,
"name": "delete",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 168,
"name": "delete",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs a DELETE on the table."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 167,
"name": "PostgrestQueryBuilder.delete"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 39,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 167,
"name": "PostgrestQueryBuilder.delete"
}
},
{
"id": 157,
"name": "insert",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 158,
"name": "insert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an INSERT into the table."
},
"parameters": [
{
"id": 159,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to insert."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 160,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 161,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 163,
"name": "onConflict",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint.\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 26,
"character": 66
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 162,
"name": "upsert",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, performs an UPSERT."
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 26,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
163,
162
]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 26,
"character": 45
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 157,
"name": "PostgrestQueryBuilder.insert"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 26,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 157,
"name": "PostgrestQueryBuilder.insert"
}
},
{
"id": 147,
"name": "on",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 148,
"name": "on",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Subscribe to realtime changes in your databse."
},
"parameters": [
{
"id": 149,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The database event which you would like to receive updates for, or you can use the special wildcard `*` to listen to all changes."
},
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "INSERT"
},
{
"type": "stringLiteral",
"value": "UPDATE"
},
{
"type": "stringLiteral",
"value": "DELETE"
},
{
"type": "stringLiteral",
"value": "*"
}
]
}
},
{
"id": 150,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A callback that will handle the payload that is sent whenever your database changes.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 151,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 152,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 153,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 15,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "SupabaseRealtimePayload"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 37,
"character": 13
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 116,
"name": "SupabaseRealtimeClient"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 35,
"character": 4
}
]
},
{
"id": 154,
"name": "select",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 155,
"name": "select",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs horizontal filtering with SELECT."
},
"parameters": [
{
"id": 156,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The columns to retrieve, separated by commas.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 154,
"name": "PostgrestQueryBuilder.select"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 18,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 154,
"name": "PostgrestQueryBuilder.select"
}
},
{
"id": 177,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 178,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 179,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 180,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 181,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 182,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 183,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 184,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 40,
"character": 75
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 185,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 186,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 187,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 188,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 40,
"character": 176
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 177,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 40,
"character": 8
}
],
"inheritedFrom": {
"type": "reference",
"id": 177,
"name": "PostgrestBuilder.then"
}
},
{
"id": 164,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 165,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an UPDATE on the table."
},
"parameters": [
{
"id": 166,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to update.\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 164,
"name": "PostgrestQueryBuilder.update"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 35,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 164,
"name": "PostgrestQueryBuilder.update"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
135
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
134,
133,
176,
171,
169,
175,
170
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
167,
157,
147,
154,
177,
164
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 6,
"character": 33
}
],
"extendedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestQueryBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
131
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 115,
"name": "\"lib/SupabaseRealtimeClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/lib/SupabaseRealtimeClient.ts",
"children": [
{
"id": 116,
"name": "SupabaseRealtimeClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 118,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 119,
"name": "new SupabaseRealtimeClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 120,
"name": "socket",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 121,
"name": "schema",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 122,
"name": "tableName",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 116,
"name": "SupabaseRealtimeClient"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 5,
"character": 36
}
]
},
{
"id": 117,
"name": "subscription",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 5,
"character": 14
}
],
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
},
{
"id": 123,
"name": "on",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 124,
"name": "on",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The event you want to listen to."
},
"parameters": [
{
"id": 125,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The event"
},
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "INSERT"
},
{
"type": "stringLiteral",
"value": "UPDATE"
},
{
"type": "stringLiteral",
"value": "DELETE"
},
{
"type": "stringLiteral",
"value": "*"
}
]
}
},
{
"id": 126,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A callback function that is called whenever the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "unknown",
"name": "this"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 18,
"character": 4
}
]
},
{
"id": 127,
"name": "subscribe",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 128,
"name": "subscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Enables the subscription."
},
"parameters": [
{
"id": 129,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
},
"defaultValue": "() => {}"
}
],
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 55,
"character": 11
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
118
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
117
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
123,
127
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 4,
"character": 35
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
116
]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/constants\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/lib/constants.ts",
"children": [
{
"id": 2,
"name": "DEFAULT_HEADERS",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "src/lib/constants.ts",
"line": 3,
"character": 28
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 3,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
2
]
}
],
"sources": [
{
"fileName": "src/lib/constants.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 246,
"name": "\"lib/helpers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/lib/helpers.ts",
"children": [
{
"id": 247,
"name": "uuid",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 248,
"name": "uuid",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "src/lib/helpers.ts",
"line": 3,
"character": 20
}
]
}
],
"groups": [
{
"title": "Functions",
"kind": 64,
"children": [
247
]
}
],
"sources": [
{
"fileName": "src/lib/helpers.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 4,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/Users/copple/Projects/Kade/supabase-js/src/lib/types.ts",
"children": [
{
"id": 5,
"name": "SupabaseClientOptions",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 33
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 6,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 12,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 13,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 14,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 21,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 8,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Optional headers for initializing the client."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 9,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 9,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 10,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 11,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 13,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 17,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 7,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 5,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
12,
14,
8,
13,
7
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 35
}
]
}
}
},
{
"id": 15,
"name": "SupabaseRealtimePayload",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 16,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 24,
"character": 35
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 17,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 18,
"name": "commit_timestamp",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 25,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 19,
"name": "eventType",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 26,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "INSERT"
},
{
"type": "stringLiteral",
"value": "UPDATE"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
}
},
{
"id": 22,
"name": "new",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The new record. Present for 'INSERT' and 'UPDATE' events."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 30,
"character": 5
}
],
"type": {
"type": "typeParameter",
"name": "T"
}
},
{
"id": 23,
"name": "old",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The previous record. Present for 'UPDATE' and 'DELETE' events."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 32,
"character": 5
}
],
"type": {
"type": "typeParameter",
"name": "T"
}
},
{
"id": 20,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 21,
"name": "table",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 28,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
18,
19,
22,
23,
20,
21
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 24,
"character": 40
}
]
}
}
}
],
"groups": [
{
"title": "Type aliases",
"kind": 4194304,
"children": [
5,
15
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [
189,
240,
24,
130,
115,
1,
246,
4
]
}
]
},
{
"id": 0,
"name": "@supabase/gotrue-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 68,
"name": "\"GoTrueApi\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueApi.ts",
"children": [
{
"id": 69,
"name": "GoTrueApi",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 75,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 76,
"name": "new GoTrueApi",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 77,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 78,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 80,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 12,
"character": 11
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 81,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 82,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 83,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 79,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 11,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
80,
79
]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 10,
"character": 14
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 69,
"name": "GoTrueApi"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 8,
"character": 3
}
]
},
{
"id": 71,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 6,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 72,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 73,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 74,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 6,
"character": 20
}
]
}
}
},
{
"id": 70,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 5,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 110,
"name": "getUrlForProvider",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 111,
"name": "getUrlForProvider",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Generates the relevant login URL for a third-party provider."
},
"parameters": [
{
"id": 112,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "One of the providers supported by GoTrue.\n"
},
"type": {
"type": "reference",
"id": 66,
"name": "Provider"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 93,
"character": 19
}
]
},
{
"id": 113,
"name": "getUser",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 114,
"name": "getUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Gets the user details."
},
"parameters": [
{
"id": 115,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 116,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 117,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 106,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 118,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 106,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
117,
118
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 119,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 120,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 108,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 121,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 108,
"character": 32
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
120,
121
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 101,
"character": 15
}
]
},
{
"id": 132,
"name": "refreshAccessToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 133,
"name": "refreshAccessToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Generates a new JWT."
},
"parameters": [
{
"id": 134,
"name": "refreshToken",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid refresh token that was returned on login.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 135,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 136,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 139,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 137,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 139,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
136,
137
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 138,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 139,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 141,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 140,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 141,
"character": 32
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
139,
140
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 132,
"character": 26
}
]
},
{
"id": 98,
"name": "resetPasswordForEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 99,
"name": "resetPasswordForEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Sends a reset request to an email address."
},
"parameters": [
{
"id": 100,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 101,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 102,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 65,
"character": 60
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 103,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 65,
"character": 61
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 104,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 65,
"character": 78
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
102,
104
]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 65,
"character": 54
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 65,
"character": 29
}
]
},
{
"id": 91,
"name": "signInWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 92,
"name": "signInWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Logs in an existing using their email address."
},
"parameters": [
{
"id": 93,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 94,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The password of the user.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 95,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 96,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 48,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 97,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 48,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
96,
97
]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 48,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 45,
"character": 23
}
]
},
{
"id": 105,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 106,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes a logged-in session."
},
"parameters": [
{
"id": 107,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 108,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 109,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 78,
"character": 45
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
109
]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 78,
"character": 38
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 78,
"character": 15
}
]
},
{
"id": 84,
"name": "signUpWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 85,
"name": "signUpWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new user using their email address."
},
"parameters": [
{
"id": 86,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 87,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The password of the user.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 88,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 89,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 31,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 90,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 31,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
89,
90
]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 31,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 28,
"character": 23
}
]
},
{
"id": 122,
"name": "updateUser",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 123,
"name": "updateUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 124,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid, logged-in JWT."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 125,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The data you want to update.\n"
},
"type": {
"type": "reference",
"id": 51,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 126,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 127,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 122,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 128,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 122,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
127,
128
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 129,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 130,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 124,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 131,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 124,
"character": 32
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
130,
131
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 117,
"character": 18
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
75
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
71,
70
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
110,
113,
132,
98,
91,
105,
84,
122
]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 4,
"character": 30
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
69
]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 180,
"name": "\"GoTrueClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueClient.ts",
"children": [
{
"id": 181,
"name": "GoTrueClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 189,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"signatures": [
{
"id": 190,
"name": "new GoTrueClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 191,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 192,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 199,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Set to \"true\" if you want to automatically refresh the token before expiring."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 46,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 198,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Set to \"true\" if you want to automatically detects OAuth grants in the URL and signs in the user."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 45,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 194,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Any additional headers to send to the GoTrue server."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 44,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 195,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 196,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 197,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 201,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "\n"
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 48,
"character": 16
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 200,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Set to \"true\" if you want to automatically save the user session into local storage."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 47,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 193,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The URL of the GoTrue server."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 43,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
199,
198,
194,
201,
200,
193
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 42,
"character": 22
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 181,
"name": "GoTrueClient"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 31,
"character": 71
}
]
},
{
"id": 182,
"name": "api",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 19,
"character": 5
}
],
"type": {
"type": "reference",
"id": 69,
"name": "GoTrueApi"
}
},
{
"id": 185,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 28,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 184,
"name": "currentSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The session object for the currently logged in user or null."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 27,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 183,
"name": "currentUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The currently logged in user or null."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 23,
"character": 23
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 187,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 30,
"character": 24
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 186,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 29,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 188,
"name": "stateChangeEmmitters",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 31,
"character": 32
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"id": 56,
"name": "Subscription"
}
],
"name": "Map"
},
"defaultValue": "new Map()"
},
{
"id": 307,
"name": "_callRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 308,
"name": "_callRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 309,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 310,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 382,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 311,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 382,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
310,
311
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 312,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 313,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 385,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 314,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 385,
"character": 32
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
313,
314
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 364,
"character": 33
}
]
},
{
"id": 271,
"name": "_handeEmailSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 272,
"name": "_handeEmailSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 273,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 274,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 275,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 276,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 287,
"character": 19
}
],
"type": {
"type": "reference",
"id": 27,
"name": "Session"
}
},
{
"id": 278,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 287,
"character": 43
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 277,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 287,
"character": 25
}
],
"type": {
"type": "reference",
"id": 33,
"name": "User"
},
"defaultValue": "data.user"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
276,
278,
277
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 279,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 280,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 289,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 282,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 289,
"character": 44
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 281,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 289,
"character": 31
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
280,
282,
281
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 277,
"character": 33
}
]
},
{
"id": 283,
"name": "_handeProviderSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 284,
"name": "_handeProviderSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 285,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 66,
"name": "Provider"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 286,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 289,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 301,
"character": 34
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 291,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 301,
"character": 59
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 287,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 301,
"character": 23
}
],
"type": {
"type": "reference",
"id": 66,
"name": "Provider"
}
},
{
"id": 288,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 301,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 290,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 301,
"character": 46
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
289,
291,
287,
288,
290
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 292,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 293,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 305,
"character": 24
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 295,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 305,
"character": 49
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 294,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 305,
"character": 36
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
293,
295,
294
]
}
]
}
}
]
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 293,
"character": 30
}
]
},
{
"id": 315,
"name": "_notifyAllSubscribers",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 316,
"name": "_notifyAllSubscribers",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 317,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 67,
"name": "AuthChangeEvent"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 389,
"character": 31
}
]
},
{
"id": 299,
"name": "_persistSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 300,
"name": "_persistSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 301,
"name": "currentSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 27,
"name": "Session"
}
},
{
"id": 302,
"name": "secondsToExpiry",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 323,
"character": 25
}
]
},
{
"id": 305,
"name": "_recoverSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 306,
"name": "_recoverSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "null"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 336,
"character": 31
}
]
},
{
"id": 303,
"name": "_removeSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 304,
"name": "_removeSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 330,
"character": 30
}
]
},
{
"id": 296,
"name": "_saveSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 297,
"name": "_saveSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 298,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 27,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 309,
"character": 22
}
]
},
{
"id": 249,
"name": "getSessionFromUrl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 250,
"name": "getSessionFromUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Gets the session data from a URL string"
},
"parameters": [
{
"id": 251,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 252,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 253,
"name": "storeSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Optionally store the session in the browser\n"
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 200,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
253
]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 254,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 255,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 201,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 256,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 201,
"character": 43
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
255,
256
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 201,
"character": 14
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 199,
"character": 25
}
]
},
{
"id": 261,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 262,
"name": "onAuthStateChange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Receive a notification every time an auth event happens.",
"returns": "A subscription object which can be used to unsubcribe itself.\n"
},
"parameters": [
{
"id": 263,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 264,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 265,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 266,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 67,
"name": "AuthChangeEvent"
}
},
{
"id": 267,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 258,
"character": 13
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 268,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 269,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 259,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 56,
"name": "Subscription"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 270,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 259,
"character": 39
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
269,
270
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 259,
"character": 4
}
]
}
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 257,
"character": 19
}
]
},
{
"id": 236,
"name": "refreshSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 237,
"name": "refreshSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Force refreshes the session including the user data in case it was updated in a different session."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 238,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 239,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 155,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 241,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 157,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 240,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 156,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
239,
241,
240
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 154,
"character": 34
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 154,
"character": 22
}
]
},
{
"id": 231,
"name": "session",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 232,
"name": "session",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the session data, if there is an active session."
},
"type": {
"type": "reflection",
"declaration": {
"id": 233,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 234,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 141,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 235,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 141,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
234,
235
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 141,
"character": 12
}
]
}
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 141,
"character": 9
}
]
},
{
"id": 212,
"name": "signIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 213,
"name": "signIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Log in an existing user, or login via a third-party provider."
},
"parameters": [
{
"id": 214,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The user login details."
},
"type": {
"type": "reflection",
"declaration": {
"id": 215,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 216,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 104,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 217,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The user's password."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 105,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 218,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "One of the providers supported by GoTrue.\n"
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 106,
"character": 12
}
],
"type": {
"type": "reference",
"id": 66,
"name": "Provider"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
216,
217,
218
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 103,
"character": 27
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 219,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 220,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 108,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 224,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 112,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 222,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 110,
"character": 12
}
],
"type": {
"type": "reference",
"id": 66,
"name": "Provider"
}
},
{
"id": 223,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 111,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 221,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 109,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
220,
224,
222,
223,
221
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 107,
"character": 14
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 103,
"character": 14
}
]
},
{
"id": 257,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 258,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Signs out the current user, if there is a logged in user."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 259,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 260,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 243,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
260
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 243,
"character": 27
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 243,
"character": 15
}
]
},
{
"id": 202,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 203,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new user."
},
"parameters": [
{
"id": 204,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The user login details."
},
"type": {
"type": "reflection",
"declaration": {
"id": 205,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 206,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 76,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 207,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's password.\n"
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 77,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
206,
207
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 75,
"character": 27
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 208,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 209,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 78,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 211,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 78,
"character": 62
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 210,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 78,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
209,
211,
210
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 78,
"character": 14
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 75,
"character": 14
}
]
},
{
"id": 242,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 243,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Updates user data, if there is a logged in user."
},
"parameters": [
{
"id": 244,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 51,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 245,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 246,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 179,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 248,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 179,
"character": 58
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 247,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 179,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
246,
248,
247
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 179,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 177,
"character": 14
}
]
},
{
"id": 225,
"name": "user",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 226,
"name": "user",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the user data, if there is a logged in user."
},
"type": {
"type": "reflection",
"declaration": {
"id": 227,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 228,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 128,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 230,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 128,
"character": 55
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 229,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 128,
"character": 35
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 33,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
228,
230,
229
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 128,
"character": 9
}
]
}
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 128,
"character": 6
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
189
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
182,
185,
184,
183,
187,
186,
188
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
307,
271,
283,
315,
299,
305,
303,
296,
249,
261,
236,
231,
212,
257,
202,
242,
225
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 14,
"character": 33
}
]
},
{
"id": 318,
"name": "DEFAULT_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 320,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 8,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 323,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 11,
"character": 20
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 324,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 12,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 325,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
},
"defaultValue": "DEFAULT_HEADERS"
},
{
"id": 322,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 10,
"character": 14
}
],
"type": {
"type": "reference",
"name": "Storage"
},
"defaultValue": "global.localStorage"
},
{
"id": 321,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 9,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 319,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 7,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "GOTRUE_URL"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
320,
323,
324,
322,
321,
319
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 6,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
181
]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [
318
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 326,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/index.ts",
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 173,
"name": "\"lib/constants\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/constants.ts",
"children": [
{
"id": 175,
"name": "AUDIENCE",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 2,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "process.env.AUDIENCE || ''"
},
{
"id": 176,
"name": "DEFAULT_HEADERS",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 3,
"character": 28
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 177,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
}
},
{
"id": 178,
"name": "EXPIRY_MARGIN",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 4,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
}
]
},
"defaultValue": "process.env.EXPIRY_MARGIN || 60 * 1000"
},
{
"id": 174,
"name": "GOTRUE_URL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 23
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "process.env.GOTRUE_URL || 'http://localhost:9999'"
},
{
"id": 179,
"name": "STORAGE_KEY",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 5,
"character": 24
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "process.env.STORAGE_KEY || 'supabase.auth.token'"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
175,
176,
178,
174,
179
]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/fetch\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/fetch.ts",
"children": [
{
"id": 2,
"name": "FetchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 3,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 4,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 4,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 5,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 6,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 7,
"name": "noResolveJson",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 7,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
3,
7
]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 3,
"character": 29
}
]
},
{
"id": 12,
"name": "get",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 13,
"name": "get",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 14,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 15,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 22,
"character": 25
}
]
},
{
"id": 8,
"name": "handleError",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 9,
"name": "handleError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 10,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 11,
"name": "reject",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 10,
"character": 17
}
]
},
{
"id": 16,
"name": "post",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 17,
"name": "post",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 18,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 19,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 20,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 37,
"character": 26
}
]
},
{
"id": 21,
"name": "put",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 22,
"name": "put",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 23,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 24,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 25,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 53,
"character": 25
}
]
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [
2
]
},
{
"title": "Functions",
"kind": 64,
"children": [
12,
8,
16,
21
]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 141,
"name": "\"lib/helpers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/helpers.ts",
"children": [
{
"id": 142,
"name": "LocalStorage",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 144,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 145,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"children": [
{
"id": 147,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 148,
"name": "new LocalStorage",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 149,
"name": "localStorage",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Storage"
}
}
],
"type": {
"type": "reference",
"id": 142,
"name": "LocalStorage"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 24,
"character": 17
}
]
},
{
"id": 146,
"name": "length",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 24,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 143,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 22,
"character": 14
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 150,
"name": "clear",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 151,
"name": "clear",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 28,
"character": 7
}
]
},
{
"id": 159,
"name": "getItem",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 160,
"name": "getItem",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 161,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 37,
"character": 9
}
]
},
{
"id": 152,
"name": "key",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 153,
"name": "key",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 154,
"name": "index",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 31,
"character": 5
}
]
},
{
"id": 162,
"name": "removeItem",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 163,
"name": "removeItem",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 164,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 40,
"character": 12
}
]
},
{
"id": 155,
"name": "setItem",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 156,
"name": "setItem",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 157,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 158,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 34,
"character": 9
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
147
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
146,
143
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
150,
159,
152,
162,
155
]
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 21,
"character": 25
}
],
"implementedTypes": [
{
"type": "reference",
"name": "Storage"
}
]
},
{
"id": 169,
"name": "getParameterByName",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 170,
"name": "getParameterByName",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 171,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 172,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 11,
"character": 34
}
]
},
{
"id": 167,
"name": "isBrowser",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 168,
"name": "isBrowser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 9,
"character": 22
}
]
},
{
"id": 165,
"name": "uuid",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 166,
"name": "uuid",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 20
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
142
]
},
{
"title": "Functions",
"kind": 64,
"children": [
169,
167,
165
]
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 26,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/types.ts",
"children": [
{
"id": 27,
"name": "Session",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 28,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 6,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 29,
"name": "expires_in",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 7,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 30,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 8,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 31,
"name": "token_type",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 9,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 32,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 10,
"character": 6
}
],
"type": {
"type": "reference",
"id": 33,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
28,
29,
30,
31,
32
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 5,
"character": 24
}
]
},
{
"id": 56,
"name": "Subscription",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 58,
"name": "callback",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 58,
"character": 10
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 59,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 60,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 61,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 67,
"name": "AuthChangeEvent"
}
},
{
"id": 62,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 27,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 58,
"character": 11
}
]
}
}
},
{
"id": 57,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The subscriber UUID. This will be set by the client."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 63,
"name": "unsubscribe",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Call this to remove the listener."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 62,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 64,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 65,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 62,
"character": 14
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
58,
57,
63
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 50,
"character": 29
}
]
},
{
"id": 33,
"name": "User",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 35,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 14,
"character": 14
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 36,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 38,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 39,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"children": [
{
"id": 37,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 15,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
37
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 14,
"character": 15
}
]
}
}
},
{
"id": 44,
"name": "aud",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 47,
"name": "confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 24,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 46,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 23,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 45,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 34,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 13,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 48,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 25,
"character": 17
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 49,
"name": "role",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 26,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 50,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 27,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 40,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 18,
"character": 15
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 41,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 42,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 43,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 18,
"character": 16
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
35,
44,
47,
46,
45,
34,
48,
49,
50,
40
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 12,
"character": 21
}
]
},
{
"id": 51,
"name": "UserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 55,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "A custom data object. Can be any JSON."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 47,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
},
{
"id": 52,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 34,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 54,
"name": "email_change_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "An email change token."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 53,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 38,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
55,
52,
54,
53
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 30,
"character": 31
}
]
},
{
"id": 67,
"name": "AuthChangeEvent",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 3,
"character": 27
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "SIGNED_IN"
},
{
"type": "stringLiteral",
"value": "SIGNED_OUT"
},
{
"type": "stringLiteral",
"value": "USER_UPDATED"
}
]
}
},
{
"id": 66,
"name": "Provider",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "bitbucket"
},
{
"type": "stringLiteral",
"value": "github"
},
{
"type": "stringLiteral",
"value": "gitlab"
},
{
"type": "stringLiteral",
"value": "google"
}
]
}
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [
27,
56,
33,
51
]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [
67,
66
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [
68,
180,
326,
173,
1,
141,
26
]
}
]
},
{
"id": 0,
"name": "@supabase/postgrest-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 319,
"name": "\"PostgrestClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/PostgrestClient.ts",
"children": [
{
"id": 320,
"name": "PostgrestClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 327,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a PostgREST client."
},
"signatures": [
{
"id": 328,
"name": "new PostgrestClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a PostgREST client."
},
"parameters": [
{
"id": 329,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "URL of the PostgREST endpoint."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 330,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 331,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 332,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Custom headers."
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 18,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 333,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 334,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 335,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 336,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Postgres schema to switch to.\n"
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 18,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
332,
336
]
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 17,
"character": 16
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 320,
"name": "PostgrestClient"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 7,
"character": 17
}
]
},
{
"id": 322,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 6,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 323,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 324,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 325,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 6,
"character": 10
}
]
}
}
},
{
"id": 326,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 7,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 321,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 5,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 337,
"name": "auth",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 338,
"name": "auth",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Authenticates the request with JWT."
},
"parameters": [
{
"id": 339,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The JWT token to use.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 30,
"character": 6
}
]
},
{
"id": 340,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 341,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a table operation."
},
"typeParameter": [
{
"id": 342,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 343,
"name": "table",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The table name to operate on.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 269,
"typeArguments": [
{
"type": "typeParameter",
"name": "T",
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"name": "PostgrestQueryBuilder"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 40,
"character": 6
}
]
},
{
"id": 344,
"name": "rpc",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 345,
"name": "rpc",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a stored procedure call."
},
"typeParameter": [
{
"id": 346,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 347,
"name": "fn",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The function name to call."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 348,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The parameters to pass to the function call.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reference",
"id": 21,
"typeArguments": [
{
"type": "typeParameter",
"name": "T",
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"name": "PostgrestBuilder"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 51,
"character": 5
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
327
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
322,
326,
321
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
337,
340,
344
]
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 4,
"character": 36
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
320
]
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 349,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/index.ts",
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 95,
"name": "\"lib/PostgrestFilterBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestFilterBuilder.ts",
"children": [
{
"id": 96,
"name": "PostgrestFilterBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 97,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 248,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 249,
"name": "new PostgrestFilterBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 250,
"name": "builder",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 21,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
}
],
"type": {
"type": "reference",
"id": 96,
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 44
}
],
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.__constructor"
}
},
{
"id": 247,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 30,
"name": "PostgrestBuilder.body"
}
},
{
"id": 242,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 243,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 244,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 245,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 21
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 25,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 240,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 39,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 23,
"name": "PostgrestBuilder.method"
}
},
{
"id": 246,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 29,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 241,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 40,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 24,
"name": "PostgrestBuilder.url"
}
},
{
"id": 170,
"name": "adj",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 171,
"name": "adj",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` is adjacent to\nthe specified `range`."
},
"parameters": [
{
"id": 172,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 173,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 274,
"character": 5
}
]
},
{
"id": 150,
"name": "cd",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 151,
"name": "cd",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose json, array, or range value on the stated `column` is\ncontained by the specified `value`."
},
"parameters": [
{
"id": 152,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 153,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 205,
"character": 4
}
]
},
{
"id": 146,
"name": "cs",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 147,
"name": "cs",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose json, array, or range value on the stated `column`\ncontains the values specified in `value`."
},
"parameters": [
{
"id": 148,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 149,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 183,
"character": 4
}
]
},
{
"id": 106,
"name": "eq",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 107,
"name": "eq",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` exactly matches the\nspecified `value`."
},
"parameters": [
{
"id": 108,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 109,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 63,
"character": 4
}
]
},
{
"id": 206,
"name": "filter",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 207,
"name": "filter",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose `column` satisfies the filter."
},
"parameters": [
{
"id": 208,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 209,
"name": "operator",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The operator to filter with."
},
"type": {
"type": "reference",
"id": 267,
"name": "FilterOperator"
}
},
{
"id": 210,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 360,
"character": 8
}
]
},
{
"id": 178,
"name": "fts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 179,
"name": "fts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nto_tsquery(`query`)."
},
"parameters": [
{
"id": 180,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 181,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 182,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 183,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 184,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 305,
"character": 46
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
184
]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 305,
"character": 37
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 305,
"character": 5
}
]
},
{
"id": 114,
"name": "gt",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 115,
"name": "gt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is greater than the\nspecified `value`."
},
"parameters": [
{
"id": 116,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 117,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 87,
"character": 4
}
]
},
{
"id": 118,
"name": "gte",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 119,
"name": "gte",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is greater than or\nequal to the specified `value`."
},
"parameters": [
{
"id": 120,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 121,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 99,
"character": 5
}
]
},
{
"id": 134,
"name": "ilike",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 135,
"name": "ilike",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case insensitive)."
},
"parameters": [
{
"id": 136,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 137,
"name": "pattern",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The pattern to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 147,
"character": 7
}
]
},
{
"id": 142,
"name": "in",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 143,
"name": "in",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is found on the\nspecified `values`."
},
"parameters": [
{
"id": 144,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 145,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to filter with.\n"
},
"type": {
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 171,
"character": 4
}
]
},
{
"id": 138,
"name": "is",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 139,
"name": "is",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "A check for exact equality (null, true, false), finds all rows whose\nvalue on the stated `column` exactly match the specified `value`."
},
"parameters": [
{
"id": 140,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 141,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "boolean"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 159,
"character": 4
}
]
},
{
"id": 130,
"name": "like",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 131,
"name": "like",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case sensitive)."
},
"parameters": [
{
"id": 132,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 133,
"name": "pattern",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The pattern to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 135,
"character": 6
}
]
},
{
"id": 225,
"name": "limit",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 226,
"name": "limit",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result with the specified `count`."
},
"parameters": [
{
"id": 227,
"name": "count",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The maximum no. of rows to limit to."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 228,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 229,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 230,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 40,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
230
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 39,
"character": 18
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 47,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 57,
"name": "PostgrestTransformBuilder.limit"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 38,
"character": 7
}
],
"inheritedFrom": {
"type": "reference",
"id": 57,
"name": "PostgrestTransformBuilder.limit"
}
},
{
"id": 122,
"name": "lt",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 123,
"name": "lt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is less than the\nspecified `value`."
},
"parameters": [
{
"id": 124,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 125,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 111,
"character": 4
}
]
},
{
"id": 126,
"name": "lte",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 127,
"name": "lte",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is less than or equal\nto the specified `value`."
},
"parameters": [
{
"id": 128,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 129,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 123,
"character": 5
}
]
},
{
"id": 211,
"name": "match",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 212,
"name": "match",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose columns match the specified `query` object."
},
"parameters": [
{
"id": 213,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The object to filter with, with column names as keys mapped\n to their filter values.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 214,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 215,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 216,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 371,
"character": 14
}
]
}
}
}
],
"type": {
"type": "unknown",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 371,
"character": 7
}
]
},
{
"id": 110,
"name": "neq",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 111,
"name": "neq",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` doesn't match the\nspecified `value`."
},
"parameters": [
{
"id": 112,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 113,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 75,
"character": 5
}
]
},
{
"id": 98,
"name": "not",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 99,
"name": "not",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows which doesn't satisfy the filter."
},
"parameters": [
{
"id": 100,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 101,
"name": "operator",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The operator to filter with."
},
"type": {
"type": "reference",
"id": 267,
"name": "FilterOperator"
}
},
{
"id": 102,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 41,
"character": 5
}
]
},
{
"id": 162,
"name": "nxl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 163,
"name": "nxl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the left of the specified `range`."
},
"parameters": [
{
"id": 164,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 165,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 250,
"character": 5
}
]
},
{
"id": 166,
"name": "nxr",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 167,
"name": "nxr",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the right of the specified `range`."
},
"parameters": [
{
"id": 168,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 169,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 262,
"character": 5
}
]
},
{
"id": 103,
"name": "or",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 104,
"name": "or",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows satisfying at least one of the filters."
},
"parameters": [
{
"id": 105,
"name": "filters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The filters to use, separated by commas.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 51,
"character": 4
}
]
},
{
"id": 217,
"name": "order",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 218,
"name": "order",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Orders the result with the specified `column`."
},
"parameters": [
{
"id": 219,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to order on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 220,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 221,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 222,
"name": "ascending",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, the result will be in ascending order."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 19,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 224,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (if `column` is a foreign column).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 21,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 223,
"name": "nullsFirst",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, `null`s appear first."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 20,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
222,
224,
223
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 17,
"character": 20
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 47,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 49,
"name": "PostgrestTransformBuilder.order"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 16,
"character": 7
}
],
"inheritedFrom": {
"type": "reference",
"id": 49,
"name": "PostgrestTransformBuilder.order"
}
},
{
"id": 174,
"name": "ov",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 175,
"name": "ov",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose array or range value on the stated `column` is\ncontained by the specified `value`."
},
"parameters": [
{
"id": 176,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 177,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 286,
"character": 4
}
]
},
{
"id": 192,
"name": "phfts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 193,
"name": "phfts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nphraseto_tsquery(`query`)."
},
"parameters": [
{
"id": 194,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 195,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 196,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 197,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 198,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 333,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
198
]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 333,
"character": 39
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 333,
"character": 7
}
]
},
{
"id": 185,
"name": "plfts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 186,
"name": "plfts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nplainto_tsquery(`query`)."
},
"parameters": [
{
"id": 187,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 188,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 189,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 190,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 191,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 319,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
191
]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 319,
"character": 39
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 319,
"character": 7
}
]
},
{
"id": 231,
"name": "range",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 232,
"name": "range",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result to rows within the specified range, inclusive."
},
"parameters": [
{
"id": 233,
"name": "from",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The starting index from which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 234,
"name": "to",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The last index to which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 235,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 236,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 237,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 57,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
237
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 56,
"character": 15
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 47,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 63,
"name": "PostgrestTransformBuilder.range"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 54,
"character": 7
}
],
"inheritedFrom": {
"type": "reference",
"id": 63,
"name": "PostgrestTransformBuilder.range"
}
},
{
"id": 238,
"name": "single",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 239,
"name": "single",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 14,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestSingleResponse"
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 70,
"name": "PostgrestTransformBuilder.single"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 71,
"character": 8
}
],
"inheritedFrom": {
"type": "reference",
"id": 70,
"name": "PostgrestTransformBuilder.single"
}
},
{
"id": 154,
"name": "sl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 155,
"name": "sl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` is strictly to the\nleft of the specified `range`."
},
"parameters": [
{
"id": 156,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 157,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 226,
"character": 4
}
]
},
{
"id": 158,
"name": "sr",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 159,
"name": "sr",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` is strictly to\nthe right of the specified `range`."
},
"parameters": [
{
"id": 160,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 161,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 238,
"character": 4
}
]
},
{
"id": 251,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 252,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 253,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 254,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 255,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 256,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 257,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 258,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 259,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 260,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 261,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 262,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 49,
"character": 6
}
],
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "PostgrestBuilder.then"
}
},
{
"id": 199,
"name": "wfts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 200,
"name": "wfts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nwebsearch_to_tsquery(`query`)."
},
"parameters": [
{
"id": 201,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 202,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 203,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 204,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 205,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 347,
"character": 47
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
205
]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 347,
"character": 38
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 347,
"character": 6
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
248
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
247,
242,
240,
246,
241
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
170,
150,
146,
106,
206,
178,
114,
118,
134,
142,
138,
130,
225,
122,
126,
211,
110,
98,
162,
166,
103,
217,
174,
192,
185,
231,
238,
154,
158,
251,
199
]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 33,
"character": 43
}
],
"extendedTypes": [
{
"type": "reference",
"id": 47,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
},
{
"id": 267,
"name": "FilterOperator",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 9,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "eq"
},
{
"type": "stringLiteral",
"value": "neq"
},
{
"type": "stringLiteral",
"value": "gt"
},
{
"type": "stringLiteral",
"value": "gte"
},
{
"type": "stringLiteral",
"value": "lt"
},
{
"type": "stringLiteral",
"value": "lte"
},
{
"type": "stringLiteral",
"value": "like"
},
{
"type": "stringLiteral",
"value": "ilike"
},
{
"type": "stringLiteral",
"value": "is"
},
{
"type": "stringLiteral",
"value": "in"
},
{
"type": "stringLiteral",
"value": "cs"
},
{
"type": "stringLiteral",
"value": "cd"
},
{
"type": "stringLiteral",
"value": "sl"
},
{
"type": "stringLiteral",
"value": "sr"
},
{
"type": "stringLiteral",
"value": "nxl"
},
{
"type": "stringLiteral",
"value": "nxr"
},
{
"type": "stringLiteral",
"value": "adj"
},
{
"type": "stringLiteral",
"value": "ov"
},
{
"type": "stringLiteral",
"value": "fts"
},
{
"type": "stringLiteral",
"value": "plfts"
},
{
"type": "stringLiteral",
"value": "phfts"
},
{
"type": "stringLiteral",
"value": "wfts"
}
]
}
},
{
"id": 263,
"name": "cleanFilterArray",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"comment": {
"shortText": "Filters"
},
"signatures": [
{
"id": 264,
"name": "cleanFilterArray",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Filters"
},
"typeParameter": [
{
"id": 265,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"parameters": [
{
"id": 266,
"name": "filter",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 7,
"character": 22
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
96
]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [
267
]
},
{
"title": "Functions",
"kind": 64,
"children": [
263
]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 268,
"name": "\"lib/PostgrestQueryBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestQueryBuilder.ts",
"children": [
{
"id": 269,
"name": "PostgrestQueryBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"comment": {
"shortText": "CRUD"
},
"typeParameter": [
{
"id": 270,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 271,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 272,
"name": "new PostgrestQueryBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 273,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 274,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 275,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 276,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 11,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 277,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 278,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 279,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 280,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 11,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
276,
280
]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 10,
"character": 16
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 269,
"name": "PostgrestQueryBuilder"
},
"overwrites": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 8,
"character": 75
}
],
"overwrites": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.__constructor"
}
},
{
"id": 306,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 30,
"name": "PostgrestBuilder.body"
}
},
{
"id": 301,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 302,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 303,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 304,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 21
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 25,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 299,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 39,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 23,
"name": "PostgrestBuilder.method"
}
},
{
"id": 305,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 29,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 300,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 40,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 24,
"name": "PostgrestBuilder.url"
}
},
{
"id": 294,
"name": "delete",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 295,
"name": "delete",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs a DELETE on the table."
},
"type": {
"type": "reference",
"id": 96,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 79,
"character": 8
}
]
},
{
"id": 284,
"name": "insert",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 285,
"name": "insert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an INSERT into the table."
},
"parameters": [
{
"id": 286,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to insert."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 287,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 288,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 290,
"name": "onConflict",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint.\n"
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 53,
"character": 32
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 289,
"name": "upsert",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, performs an UPSERT."
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 53,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
290,
289
]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 52,
"character": 38
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 96,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 51,
"character": 8
}
]
},
{
"id": 281,
"name": "select",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 282,
"name": "select",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs horizontal filtering with SELECT."
},
"parameters": [
{
"id": 283,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The columns to retrieve, separated by commas.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"*\""
}
],
"type": {
"type": "reference",
"id": 96,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 24,
"character": 8
}
]
},
{
"id": 307,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 308,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 309,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 310,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 311,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 312,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 313,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 314,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 315,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 316,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 317,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 318,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 49,
"character": 6
}
],
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "PostgrestBuilder.then"
}
},
{
"id": 291,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 292,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an UPDATE on the table."
},
"parameters": [
{
"id": 293,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to update.\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
],
"type": {
"type": "reference",
"id": 96,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 69,
"character": 8
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
271
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
306,
301,
299,
305,
300
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
294,
284,
281,
307,
291
]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 8,
"character": 42
}
],
"extendedTypes": [
{
"type": "reference",
"id": 21,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
269
]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 46,
"name": "\"lib/PostgrestTransformBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestTransformBuilder.ts",
"children": [
{
"id": 47,
"name": "PostgrestTransformBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Post-filters (transforms)"
},
"typeParameter": [
{
"id": 48,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 80,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 81,
"name": "new PostgrestTransformBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 82,
"name": "builder",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 21,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
}
],
"type": {
"type": "reference",
"id": 47,
"name": "PostgrestTransformBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 44
}
],
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.__constructor"
}
},
{
"id": 79,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 30,
"name": "PostgrestBuilder.body"
}
},
{
"id": 74,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 75,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 76,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 77,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 21
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 25,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 72,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 39,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 23,
"name": "PostgrestBuilder.method"
}
},
{
"id": 78,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 29,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 73,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 40,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 24,
"name": "PostgrestBuilder.url"
}
},
{
"id": 57,
"name": "limit",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 58,
"name": "limit",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result with the specified `count`."
},
"parameters": [
{
"id": 59,
"name": "count",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The maximum no. of rows to limit to."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 60,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 61,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 62,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 40,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
62
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 39,
"character": 18
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 47,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 38,
"character": 7
}
]
},
{
"id": 49,
"name": "order",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 50,
"name": "order",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Orders the result with the specified `column`."
},
"parameters": [
{
"id": 51,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to order on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 52,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 53,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 54,
"name": "ascending",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, the result will be in ascending order."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 19,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 56,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (if `column` is a foreign column).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 21,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 55,
"name": "nullsFirst",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, `null`s appear first."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 20,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
54,
56,
55
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 17,
"character": 20
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 47,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 16,
"character": 7
}
]
},
{
"id": 63,
"name": "range",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 64,
"name": "range",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result to rows within the specified range, inclusive."
},
"parameters": [
{
"id": 65,
"name": "from",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The starting index from which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 66,
"name": "to",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The last index to which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 67,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 68,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 69,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 57,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
69
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 56,
"character": 15
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 47,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 54,
"character": 7
}
]
},
{
"id": 70,
"name": "single",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 71,
"name": "single",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 14,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestSingleResponse"
}
],
"name": "PromiseLike"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 71,
"character": 8
}
]
},
{
"id": 83,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 84,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 85,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 86,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 87,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 88,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 89,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 90,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 91,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 92,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 93,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 94,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 49,
"character": 6
}
],
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "PostgrestBuilder.then"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
80
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
79,
74,
72,
78,
73
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
57,
49,
63,
70,
83
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 7,
"character": 46
}
],
"extendedTypes": [
{
"type": "reference",
"id": 21,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
],
"extendedBy": [
{
"type": "reference",
"id": 96,
"name": "PostgrestFilterBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
47
]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/types.ts",
"children": [
{
"id": 21,
"name": "PostgrestBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true,
"isAbstract": true
},
"typeParameter": [
{
"id": 22,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 31,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 32,
"name": "new PostgrestBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 33,
"name": "builder",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 21,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
}
],
"type": {
"type": "reference",
"id": 21,
"name": "PostgrestBuilder"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 44
}
]
},
{
"id": 30,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 25,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 26,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 27,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 28,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 21
}
]
}
}
},
{
"id": 23,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 39,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
}
},
{
"id": 29,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 24,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 40,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
}
},
{
"id": 34,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 35,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 36,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 37,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 38,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 39,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 40,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 41,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 42,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 43,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 44,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 45,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 49,
"character": 6
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
31
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
30,
25,
23,
29,
24
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
34
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 38,
"character": 38
}
],
"extendedBy": [
{
"type": "reference",
"id": 47,
"name": "PostgrestTransformBuilder"
},
{
"type": "reference",
"id": 269,
"name": "PostgrestQueryBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 7,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
},
{
"id": 2,
"name": "PostgrestError",
"kind": 256,
"kindString": "Interface",
"flags": {},
"comment": {
"shortText": "Error format",
"text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n"
},
"children": [
{
"id": 6,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 12,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 4,
"name": "details",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 10,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 5,
"name": "hint",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 11,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 3,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 9,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
6,
4,
5,
3
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 8,
"character": 24
}
]
},
{
"id": 7,
"name": "PostgrestResponse",
"kind": 256,
"kindString": "Interface",
"flags": {},
"comment": {
"shortText": "Response format",
"text": "{@link https://github.com/supabase/supabase-js/issues/32}\n"
},
"typeParameter": [
{
"id": 8,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"children": [
{
"id": 13,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 26,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "typeParameter",
"name": "T"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 10,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "typeParameter",
"name": "T"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 9,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 2,
"name": "PostgrestError"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 11,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 23,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 12,
"name": "statusText",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 24,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
13,
10,
9,
11,
12
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 20,
"character": 27
}
]
},
{
"id": 14,
"name": "PostgrestSingleResponse",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 15,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 20,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 35,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "T"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 17,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 31,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "T"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 16,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 30,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 2,
"name": "PostgrestError"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 18,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 32,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 19,
"name": "statusText",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 33,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
20,
17,
16,
18,
19
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 29,
"character": 40
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
21
]
},
{
"title": "Interfaces",
"kind": 256,
"children": [
2,
7,
14
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [
319,
349,
95,
268,
46,
1
]
}
]
},
{
"id": 0,
"name": "@supabase/realtime-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 169,
"name": "\"RealtimeClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/RealtimeClient.ts",
"children": [
{
"id": 170,
"name": "RealtimeClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 200,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Socket"
},
"signatures": [
{
"id": 201,
"name": "new RealtimeClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Socket"
},
"parameters": [
{
"id": 202,
"name": "endPoint",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 203,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 273,
"name": "Options"
}
}
],
"type": {
"type": "reference",
"id": 170,
"name": "RealtimeClient"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 64,
"character": 3
}
]
},
{
"id": 171,
"name": "channels",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 36,
"character": 10
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
},
"defaultValue": "[]"
},
{
"id": 193,
"name": "conn",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 52,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "WebSocket"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 191,
"name": "decode",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 50,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 190,
"name": "encode",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 49,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 172,
"name": "endPoint",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 37,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"\""
},
{
"id": 173,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 38,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 174,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 175,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 176,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 183,
"name": "heartbeatIntervalMs",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 42,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "30000"
},
{
"id": 185,
"name": "heartbeatTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 44,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "undefined"
}
]
},
"defaultValue": "undefined"
},
{
"id": 189,
"name": "logger",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 48,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
},
"defaultValue": "noop"
},
{
"id": 184,
"name": "longpollerTimeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 43,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "20000"
},
{
"id": 177,
"name": "params",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 39,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 178,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 179,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 180,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 186,
"name": "pendingHeartbeatRef",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 45,
"character": 21
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 192,
"name": "reconnectAfterMs",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 51,
"character": 18
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 188,
"name": "reconnectTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 47,
"character": 16
}
],
"type": {
"type": "reference",
"id": 25,
"name": "Timer"
}
},
{
"id": 187,
"name": "ref",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 46,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 194,
"name": "sendBuffer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 53,
"character": 12
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "Function"
}
},
"defaultValue": "[]"
},
{
"id": 181,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 40,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "DEFAULT_TIMEOUT"
},
{
"id": 182,
"name": "transport",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 41,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "WebSocket"
},
{
"id": 262,
"name": "_appendParams",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 263,
"name": "_appendParams",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 264,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 265,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 266,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 267,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 268,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 347,
"character": 44
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 347,
"character": 23
}
]
},
{
"id": 269,
"name": "_flushSendBuffer",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 270,
"name": "_flushSendBuffer",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 355,
"character": 26
}
]
},
{
"id": 254,
"name": "_onConnClose",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 255,
"name": "_onConnClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 256,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 327,
"character": 22
}
]
},
{
"id": 257,
"name": "_onConnError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 258,
"name": "_onConnError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 259,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Error"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 335,
"character": 22
}
]
},
{
"id": 252,
"name": "_onConnOpen",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 253,
"name": "_onConnOpen",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 314,
"character": 21
}
]
},
{
"id": 271,
"name": "_sendHeartbeat",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 272,
"name": "_sendHeartbeat",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 362,
"character": 24
}
]
},
{
"id": 260,
"name": "_triggerChanError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 261,
"name": "_triggerChanError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 341,
"character": 27
}
]
},
{
"id": 237,
"name": "channel",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 238,
"name": "channel",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 239,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 240,
"name": "chanParams",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 241,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 246,
"character": 9
}
]
},
{
"id": 204,
"name": "connect",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 205,
"name": "connect",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Connects the socket."
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 118,
"character": 9
}
]
},
{
"id": 230,
"name": "connectionState",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 231,
"name": "connectionState",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the current state of the socket."
},
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "connecting"
},
{
"type": "stringLiteral",
"value": "open"
},
{
"type": "stringLiteral",
"value": "closing"
},
{
"type": "stringLiteral",
"value": "closed"
}
]
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 215,
"character": 17
}
]
},
{
"id": 206,
"name": "disconnect",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 207,
"name": "disconnect",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Disconnects the socket."
},
"parameters": [
{
"id": 208,
"name": "code",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "A numeric status code to send on disconnect."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 209,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "A custom reason for the disconnect.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 210,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 212,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 142,
"character": 40
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 211,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 142,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
212,
211
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 142,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 139,
"character": 12
}
]
},
{
"id": 248,
"name": "endPointURL",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 249,
"name": "endPointURL",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the URL of the websocket."
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 293,
"character": 13
}
]
},
{
"id": 232,
"name": "isConnected",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 233,
"name": "isConnected",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retuns `true` is the connection is open."
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 231,
"character": 13
}
]
},
{
"id": 213,
"name": "log",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 214,
"name": "log",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Logs the message. Override `this.logger` for specialized logging."
},
"parameters": [
{
"id": 215,
"name": "kind",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 216,
"name": "msg",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 217,
"name": "data",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 164,
"character": 5
}
]
},
{
"id": 250,
"name": "makeRef",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 251,
"name": "makeRef",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Return the next message ref, accounting for overflows"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 303,
"character": 9
}
]
},
{
"id": 221,
"name": "onClose",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 222,
"name": "onClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Registers a callbacks for connection state change events.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen(() => console.log(\"Socket closed.\"))\n"
}
]
},
"parameters": [
{
"id": 223,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 186,
"character": 9
}
]
},
{
"id": 245,
"name": "onConnMessage",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 246,
"name": "onConnMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 247,
"name": "rawMessage",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 267,
"character": 15
}
]
},
{
"id": 224,
"name": "onError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 225,
"name": "onError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 226,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 197,
"character": 9
}
]
},
{
"id": 227,
"name": "onMessage",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 228,
"name": "onMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 229,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 208,
"character": 11
}
]
},
{
"id": 218,
"name": "onOpen",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 219,
"name": "onOpen",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Registers a callback for connection state change event.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen(() => console.log(\"Socket opened.\"))\n"
}
]
},
"parameters": [
{
"id": 220,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 175,
"character": 8
}
]
},
{
"id": 242,
"name": "push",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 243,
"name": "push",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 244,
"name": "data",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 291,
"name": "Message"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 252,
"character": 6
}
]
},
{
"id": 234,
"name": "remove",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 235,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes a subscription from the socket."
},
"parameters": [
{
"id": 236,
"name": "channel",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "An open subscription.\n"
},
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 240,
"character": 8
}
]
},
{
"id": 195,
"name": "stateChangeCallbacks",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 197,
"name": "close",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 61,
"character": 9
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
},
{
"id": 198,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 62,
"character": 9
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
},
{
"id": 199,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 63,
"character": 11
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
},
{
"id": 196,
"name": "open",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 60,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
197,
198,
199,
196
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 54,
"character": 22
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
200
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
171,
193,
191,
190,
172,
173,
183,
185,
189,
184,
177,
186,
192,
188,
187,
194,
181,
182
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
262,
269,
254,
257,
252,
271,
260,
237,
204,
230,
206,
248,
232,
213,
250,
221,
245,
224,
227,
218,
242,
234
]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [
195
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 35,
"character": 35
}
]
},
{
"id": 291,
"name": "Message",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 26,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 292,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 294,
"name": "event",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 28,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 295,
"name": "payload",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 29,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 296,
"name": "ref",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 30,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 293,
"name": "topic",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 27,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
294,
295,
296,
293
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 26,
"character": 14
}
]
}
}
},
{
"id": 273,
"name": "Options",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 274,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 281,
"name": "decode",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 21,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 280,
"name": "encode",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 20,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 283,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 23,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 284,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 285,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 286,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 277,
"name": "heartbeatIntervalMs",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 17,
"character": 21
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 279,
"name": "logger",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 19,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 278,
"name": "longpollerTimeout",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 18,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 287,
"name": "params",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 24,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 288,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 289,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 290,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 282,
"name": "reconnectAfterMs",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 22,
"character": 18
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 276,
"name": "timeout",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 16,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 275,
"name": "transport",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 15,
"character": 11
}
],
"type": {
"type": "reference",
"name": "WebSocket"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
281,
280,
283,
277,
279,
278,
287,
282,
276,
275
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 14,
"character": 14
}
]
}
}
},
{
"id": 297,
"name": "noop",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 298,
"name": "noop",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 33,
"character": 10
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
170
]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [
291,
273
]
},
{
"title": "Functions",
"kind": 64,
"children": [
297
]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 90,
"name": "\"RealtimeSubscription\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/RealtimeSubscription.ts",
"children": [
{
"id": 91,
"name": "RealtimeSubscription",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 99,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 103,
"name": "new RealtimeSubscription",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 104,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 105,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "{}"
},
{
"id": 106,
"name": "socket",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 170,
"name": "RealtimeClient"
}
}
],
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 13,
"character": 25
}
]
},
{
"id": 92,
"name": "bindings",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 7,
"character": 10
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
},
"defaultValue": "[]"
},
{
"id": 96,
"name": "joinPush",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 11,
"character": 10
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
},
{
"id": 95,
"name": "joinedOnce",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 10,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
},
{
"id": 101,
"name": "params",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 17,
"character": 17
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 98,
"name": "pushBuffer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 13,
"character": 12
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 39,
"name": "Push"
}
},
"defaultValue": "[]"
},
{
"id": 97,
"name": "rejoinTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 12,
"character": 13
}
],
"type": {
"type": "reference",
"id": 25,
"name": "Timer"
}
},
{
"id": 102,
"name": "socket",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 18,
"character": 17
}
],
"type": {
"type": "reference",
"id": 170,
"name": "RealtimeClient"
}
},
{
"id": 94,
"name": "state",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 9,
"character": 7
}
],
"type": {
"type": "reference",
"id": 7,
"name": "CHANNEL_STATES"
},
"defaultValue": "CHANNEL_STATES.closed"
},
{
"id": 93,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 8,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 100,
"name": "topic",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 16,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 125,
"name": "canPush",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 126,
"name": "canPush",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 97,
"character": 9
}
]
},
{
"id": 159,
"name": "isClosed",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 160,
"name": "isClosed",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 191,
"character": 10
}
]
},
{
"id": 161,
"name": "isErrored",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 162,
"name": "isErrored",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 194,
"character": 11
}
]
},
{
"id": 163,
"name": "isJoined",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 164,
"name": "isJoined",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 197,
"character": 10
}
]
},
{
"id": 165,
"name": "isJoining",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 166,
"name": "isJoining",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 200,
"character": 11
}
]
},
{
"id": 167,
"name": "isLeaving",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 168,
"name": "isLeaving",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 203,
"character": 11
}
]
},
{
"id": 140,
"name": "isMember",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 141,
"name": "isMember",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 142,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 151,
"character": 10
}
]
},
{
"id": 143,
"name": "joinRef",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 144,
"name": "joinRef",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 155,
"character": 9
}
]
},
{
"id": 122,
"name": "off",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 123,
"name": "off",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 124,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 93,
"character": 5
}
]
},
{
"id": 118,
"name": "on",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 119,
"name": "on",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 120,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 121,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 89,
"character": 4
}
]
},
{
"id": 112,
"name": "onClose",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 113,
"name": "onClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 114,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 81,
"character": 9
}
]
},
{
"id": 115,
"name": "onError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 116,
"name": "onError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 117,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 85,
"character": 9
}
]
},
{
"id": 135,
"name": "onMessage",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 136,
"name": "onMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 137,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 138,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 139,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 147,
"character": 11
}
]
},
{
"id": 127,
"name": "push",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 128,
"name": "push",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 129,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 13,
"name": "CHANNEL_EVENTS"
}
},
{
"id": 130,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 131,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 101,
"character": 6
}
]
},
{
"id": 148,
"name": "rejoin",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 149,
"name": "rejoin",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 150,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 164,
"character": 8
}
]
},
{
"id": 107,
"name": "rejoinUntilConnected",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 108,
"name": "rejoinUntilConnected",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 64,
"character": 22
}
]
},
{
"id": 156,
"name": "replyEventName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 157,
"name": "replyEventName",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 158,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 187,
"character": 16
}
]
},
{
"id": 145,
"name": "sendJoin",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 146,
"name": "sendJoin",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 147,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 159,
"character": 10
}
]
},
{
"id": 109,
"name": "subscribe",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 110,
"name": "subscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 111,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 71,
"character": 11
}
]
},
{
"id": 151,
"name": "trigger",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 152,
"name": "trigger",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 153,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 154,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 155,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 171,
"character": 9
}
]
},
{
"id": 132,
"name": "unsubscribe",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 133,
"name": "unsubscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 134,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 125,
"character": 13
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
99
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
92,
96,
95,
101,
98,
97,
102,
94,
93,
100
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
125,
159,
161,
163,
165,
167,
140,
143,
122,
118,
112,
115,
135,
127,
148,
107,
156,
145,
109,
151,
132
]
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 6,
"character": 41
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
91
]
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 385,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/index.ts",
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/constants\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/constants.ts",
"children": [
{
"id": 13,
"name": "CHANNEL_EVENTS",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 14,
"name": "close",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 23,
"character": 7
}
],
"defaultValue": "\"phx_close\""
},
{
"id": 15,
"name": "error",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 24,
"character": 7
}
],
"defaultValue": "\"phx_error\""
},
{
"id": 16,
"name": "join",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 25,
"character": 6
}
],
"defaultValue": "\"phx_join\""
},
{
"id": 18,
"name": "leave",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 27,
"character": 7
}
],
"defaultValue": "\"phx_leave\""
},
{
"id": 17,
"name": "reply",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 26,
"character": 7
}
],
"defaultValue": "\"phx_reply\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
14,
15,
16,
18,
17
]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 22,
"character": 26
}
]
},
{
"id": 7,
"name": "CHANNEL_STATES",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 8,
"name": "closed",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 15,
"character": 8
}
],
"defaultValue": "\"closed\""
},
{
"id": 9,
"name": "errored",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 16,
"character": 9
}
],
"defaultValue": "\"errored\""
},
{
"id": 10,
"name": "joined",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 17,
"character": 8
}
],
"defaultValue": "\"joined\""
},
{
"id": 11,
"name": "joining",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 18,
"character": 9
}
],
"defaultValue": "\"joining\""
},
{
"id": 12,
"name": "leaving",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 19,
"character": 9
}
],
"defaultValue": "\"leaving\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
8,
9,
10,
11,
12
]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 14,
"character": 26
}
]
},
{
"id": 2,
"name": "SOCKET_STATES",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 6,
"name": "closed",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 11,
"character": 8
}
],
"defaultValue": "3"
},
{
"id": 5,
"name": "closing",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 10,
"character": 9
}
],
"defaultValue": "2"
},
{
"id": 3,
"name": "connecting",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 8,
"character": 12
}
],
"defaultValue": "0"
},
{
"id": 4,
"name": "open",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 9,
"character": 6
}
],
"defaultValue": "1"
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
6,
5,
3,
4
]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 7,
"character": 25
}
]
},
{
"id": 19,
"name": "TRANSPORTS",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 20,
"name": "websocket",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 31,
"character": 11
}
],
"defaultValue": "\"websocket\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
20
]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 30,
"character": 22
}
]
},
{
"id": 22,
"name": "DEFAULT_TIMEOUT",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 3,
"character": 28
}
],
"type": {
"type": "unknown",
"name": "10000"
},
"defaultValue": "10000"
},
{
"id": 21,
"name": "VSN",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"1.0.0\""
},
{
"id": 23,
"name": "WS_CLOSE_NORMAL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 5,
"character": 28
}
],
"type": {
"type": "unknown",
"name": "1000"
},
"defaultValue": "1000"
}
],
"groups": [
{
"title": "Enumerations",
"kind": 4,
"children": [
13,
7,
2,
19
]
},
{
"title": "Variables",
"kind": 32,
"children": [
22,
21,
23
]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 38,
"name": "\"lib/push\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/push.ts",
"children": [
{
"id": 39,
"name": "Push",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 52,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Push"
},
"signatures": [
{
"id": 57,
"name": "new Push",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Push"
},
"parameters": [
{
"id": 58,
"name": "channel",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The Channel"
},
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
},
{
"id": 59,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The event, for example `\"phx_join\"`"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 60,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The payload, for example `{user_id: 123}`"
},
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "{}"
},
{
"id": 61,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The push timeout in milliseconds\n"
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "DEFAULT_TIMEOUT"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 16,
"character": 32
}
]
},
{
"id": 53,
"name": "channel",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The Channel"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 27,
"character": 18
}
],
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
},
{
"id": 54,
"name": "event",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The event, for example `\"phx_join\"`"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 28,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 55,
"name": "payload",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The payload, for example `{user_id: 123}`"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 29,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 47,
"name": "recHooks",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 12,
"character": 10
}
],
"type": {
"type": "array",
"elementType": {
"type": "reflection",
"declaration": {
"id": 48,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 50,
"name": "callback",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 49,
"name": "status",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 13,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
50,
49
]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 12,
"character": 11
}
]
}
}
},
"defaultValue": "[]"
},
{
"id": 43,
"name": "receivedResp",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 8,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 44,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 46,
"name": "response",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 10,
"character": 12
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 45,
"name": "status",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 9,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
46,
45
]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 8,
"character": 15
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 42,
"name": "ref",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 7,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"\""
},
{
"id": 51,
"name": "refEvent",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 16,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 40,
"name": "sent",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 5,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
},
{
"id": 56,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The push timeout in milliseconds\n"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 30,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 41,
"name": "timeoutTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 6,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "undefined"
}
]
},
"defaultValue": "undefined"
},
{
"id": 77,
"name": "_cancelRefEvent",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 78,
"name": "_cancelRefEvent",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 89,
"character": 25
}
]
},
{
"id": 79,
"name": "_cancelTimeout",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 80,
"name": "_cancelTimeout",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 96,
"character": 24
}
]
},
{
"id": 87,
"name": "_hasReceived",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 88,
"name": "_hasReceived",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 89,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 113,
"character": 22
}
]
},
{
"id": 81,
"name": "_matchReceive",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 82,
"name": "_matchReceive",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 83,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 84,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 86,
"name": "response",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 103,
"character": 12
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 85,
"name": "status",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 102,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
86,
85
]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 101,
"character": 24
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 101,
"character": 23
}
]
},
{
"id": 67,
"name": "receive",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 68,
"name": "receive",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 69,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 70,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "unknown",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 57,
"character": 9
}
]
},
{
"id": 62,
"name": "resend",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 63,
"name": "resend",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 64,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 33,
"character": 8
}
]
},
{
"id": 65,
"name": "send",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 66,
"name": "send",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 43,
"character": 6
}
]
},
{
"id": 71,
"name": "startTimeout",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 72,
"name": "startTimeout",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 66,
"character": 14
}
]
},
{
"id": 73,
"name": "trigger",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 74,
"name": "trigger",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 75,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 76,
"name": "response",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 85,
"character": 9
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
52
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
53,
54,
55,
47,
43,
42,
51,
40,
56,
41
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
77,
79,
87,
81,
67,
62,
65,
71,
73
]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 4,
"character": 25
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
39
]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 24,
"name": "\"lib/timer\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/timer.ts",
"children": [
{
"id": 25,
"name": "Timer",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a timer that accepts a `timerCalc` function to perform calculated timeout retries, such as exponential backoff.",
"tags": [
{
"tag": "example",
"text": "\n let reconnectTimer = new Timer(() => this.connect(), function(tries){\n return [1000, 5000, 10000][tries - 1] || 10000\n })\n reconnectTimer.scheduleTimeout() // fires after 1000\n reconnectTimer.scheduleTimeout() // fires after 5000\n reconnectTimer.reset()\n reconnectTimer.scheduleTimeout() // fires after 1000\n"
}
]
},
"children": [
{
"id": 28,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 31,
"name": "new Timer",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 32,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 33,
"name": "timerCalc",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "reference",
"id": 25,
"name": "Timer"
}
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 15,
"character": 19
}
]
},
{
"id": 29,
"name": "callback",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 17,
"character": 29
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 26,
"name": "timer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 14,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "undefined"
}
]
},
"defaultValue": "undefined"
},
{
"id": 30,
"name": "timerCalc",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 17,
"character": 57
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 27,
"name": "tries",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 15,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 34,
"name": "reset",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 35,
"name": "reset",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 22,
"character": 7
}
]
},
{
"id": 36,
"name": "scheduleTimeout",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 37,
"name": "scheduleTimeout",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 28,
"character": 17
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
28
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
29,
26,
30,
27
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
34,
36
]
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 13,
"character": 26
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
25
]
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 299,
"name": "\"lib/transformers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/transformers.ts",
"children": [
{
"id": 300,
"name": "PostgresTypes",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Helpers to convert the change Payload into native JS types."
},
"children": [
{
"id": 301,
"name": "abstime",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 9,
"character": 9
}
],
"defaultValue": "\"abstime\""
},
{
"id": 302,
"name": "bool",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 10,
"character": 6
}
],
"defaultValue": "\"bool\""
},
{
"id": 303,
"name": "date",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 11,
"character": 6
}
],
"defaultValue": "\"date\""
},
{
"id": 304,
"name": "daterange",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 12,
"character": 11
}
],
"defaultValue": "\"daterange\""
},
{
"id": 305,
"name": "float4",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 13,
"character": 8
}
],
"defaultValue": "\"float4\""
},
{
"id": 306,
"name": "float8",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 14,
"character": 8
}
],
"defaultValue": "\"float8\""
},
{
"id": 307,
"name": "int2",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 15,
"character": 6
}
],
"defaultValue": "\"int2\""
},
{
"id": 308,
"name": "int4",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 16,
"character": 6
}
],
"defaultValue": "\"int4\""
},
{
"id": 309,
"name": "int4range",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 17,
"character": 11
}
],
"defaultValue": "\"int4range\""
},
{
"id": 310,
"name": "int8",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 18,
"character": 6
}
],
"defaultValue": "\"int8\""
},
{
"id": 311,
"name": "int8range",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 19,
"character": 11
}
],
"defaultValue": "\"int8range\""
},
{
"id": 312,
"name": "json",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 20,
"character": 6
}
],
"defaultValue": "\"json\""
},
{
"id": 313,
"name": "jsonb",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 21,
"character": 7
}
],
"defaultValue": "\"jsonb\""
},
{
"id": 314,
"name": "money",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 22,
"character": 7
}
],
"defaultValue": "\"money\""
},
{
"id": 315,
"name": "numeric",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 23,
"character": 9
}
],
"defaultValue": "\"numeric\""
},
{
"id": 316,
"name": "oid",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 24,
"character": 5
}
],
"defaultValue": "\"oid\""
},
{
"id": 317,
"name": "reltime",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 25,
"character": 9
}
],
"defaultValue": "\"reltime\""
},
{
"id": 318,
"name": "time",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 26,
"character": 6
}
],
"defaultValue": "\"time\""
},
{
"id": 319,
"name": "timestamp",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 27,
"character": 11
}
],
"defaultValue": "\"timestamp\""
},
{
"id": 320,
"name": "timestamptz",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 28,
"character": 13
}
],
"defaultValue": "\"timestamptz\""
},
{
"id": 321,
"name": "timetz",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 29,
"character": 8
}
],
"defaultValue": "\"timetz\""
},
{
"id": 322,
"name": "tsrange",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 30,
"character": 9
}
],
"defaultValue": "\"tsrange\""
},
{
"id": 323,
"name": "tstzrange",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 31,
"character": 11
}
],
"defaultValue": "\"tstzrange\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
301,
302,
303,
304,
305,
306,
307,
308,
309,
310,
311,
312,
313,
314,
315,
316,
317,
318,
319,
320,
321,
322,
323
]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 8,
"character": 25
}
]
},
{
"id": 324,
"name": "Column",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 34,
"character": 11
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 325,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 326,
"name": "flags",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 35,
"character": 7
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
},
{
"id": 327,
"name": "name",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 36,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 328,
"name": "type",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 37,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 329,
"name": "type_modifier",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 38,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
326,
327,
328,
329
]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 34,
"character": 13
}
]
}
}
},
{
"id": 330,
"name": "Records",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 41,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 331,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 332,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 333,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 41,
"character": 14
}
]
}
}
},
{
"id": 350,
"name": "convertCell",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"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', 'true')\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"
}
]
},
"signatures": [
{
"id": 351,
"name": "convertCell",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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', 'true')\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": 352,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "A postgres column type"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 353,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The cell value\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 112,
"character": 24
}
]
},
{
"id": 334,
"name": "convertChangeData",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"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"
}
]
},
"signatures": [
{
"id": 335,
"name": "convertChangeData",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 336,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 324,
"name": "Column"
}
}
},
{
"id": 337,
"name": "records",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {},
"type": {
"type": "reference",
"id": 330,
"name": "Records"
}
},
{
"id": 338,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The map of various options that can be applied to the mapper"
},
"type": {
"type": "reflection",
"declaration": {
"id": 339,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 340,
"name": "skipTypes",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 60,
"character": 22
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
340
]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 60,
"character": 10
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 341,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 342,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 343,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 57,
"character": 30
}
]
},
{
"id": 344,
"name": "convertColumn",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"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'}], ['Paul', '33'], [])\n//=> 33"
},
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], ['Paul', '33'], ['int4'])\n//=> \"33\"\n"
}
]
},
"signatures": [
{
"id": 345,
"name": "convertColumn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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'}], ['Paul', '33'], [])\n//=> 33"
},
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], ['Paul', '33'], ['int4'])\n//=> \"33\"\n"
}
]
},
"parameters": [
{
"id": 346,
"name": "columnName",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The column that you want to convert"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 347,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 324,
"name": "Column"
}
}
},
{
"id": 348,
"name": "records",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The map of string values"
},
"type": {
"type": "reference",
"id": 330,
"name": "Records"
}
},
{
"id": 349,
"name": "skipTypes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "An array of types that should not be converted"
},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 85,
"character": 26
}
]
},
{
"id": 354,
"name": "noop",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 355,
"name": "noop",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 356,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 183,
"character": 10
}
]
},
{
"id": 378,
"name": "toArray",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "Converts a Postgres Array into a native JS array",
"tags": [
{
"tag": "example",
"text": "toArray('{1,2,3,4}', 'int4')\n//=> [1,2,3,4]"
},
{
"tag": "example",
"text": "toArray('{}', 'int4')\n//=> []\n"
}
]
},
"signatures": [
{
"id": 379,
"name": "toArray",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Converts a Postgres Array into a native JS array",
"tags": [
{
"tag": "example",
"text": "toArray('{1,2,3,4}', 'int4')\n//=> [1,2,3,4]"
},
{
"tag": "example",
"text": "toArray('{}', 'int4')\n//=> []\n"
}
]
},
"parameters": [
{
"id": 380,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 381,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 225,
"character": 20
}
]
},
{
"id": 357,
"name": "toBoolean",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 358,
"name": "toBoolean",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 359,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 186,
"character": 22
}
]
},
{
"id": 360,
"name": "toDate",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 361,
"name": "toDate",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 362,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"name": "Date"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 196,
"character": 19
}
]
},
{
"id": 363,
"name": "toDateRange",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 364,
"name": "toDateRange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 365,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "Date"
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 199,
"character": 24
}
]
},
{
"id": 366,
"name": "toFloat",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 367,
"name": "toFloat",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 368,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 203,
"character": 20
}
]
},
{
"id": 369,
"name": "toInt",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 370,
"name": "toInt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 371,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 206,
"character": 18
}
]
},
{
"id": 372,
"name": "toIntRange",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 373,
"name": "toIntRange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 374,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "number"
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 209,
"character": 23
}
]
},
{
"id": 375,
"name": "toJson",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 376,
"name": "toJson",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 377,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 213,
"character": 19
}
]
},
{
"id": 382,
"name": "toTimestampString",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"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"
}
]
},
"signatures": [
{
"id": 383,
"name": "toTimestampString",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 384,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 246,
"character": 30
}
]
}
],
"groups": [
{
"title": "Enumerations",
"kind": 4,
"children": [
300
]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [
324,
330
]
},
{
"title": "Functions",
"kind": 64,
"children": [
350,
334,
344,
354,
378,
357,
360,
363,
366,
369,
372,
375,
382
]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [
169,
90,
385,
1,
38,
24,
299
]
}
]
}
]
}
Reference in new issue View Git Blame Copy Permalink