{ "id": 0, "name": "@supabase/postgrest-js", "kind": 1, "kindString": "Project", "flags": {}, "originalName": "", "children": [ { "id": 610, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", "flags": { "isAbstract": true }, "children": [ { "id": 611, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 19, "character": 2 } ], "signatures": [ { "id": 612, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 613, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "parameters": [ { "id": 614, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 613, "name": "Result" } ], "name": "default" } } ], "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 613, "name": "Result" } ], "name": "default" } } ] }, { "id": 619, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 622, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 623, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 624, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 625, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 626, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 617, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 627, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 615, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 9, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 618, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 620, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 621, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } }, { "id": 616, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 630, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 49, "character": 2 } ], "signatures": [ { "id": 631, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 632, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 658, "typeArguments": [ { "type": "reference", "id": 613, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 633, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 634, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 635, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 636, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 637, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 658, "typeArguments": [ { "type": "reference", "id": 613, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 638, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 639, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 640, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 641, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 476, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 476, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult1" }, { "type": "reference", "id": 476, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "implementationOf": { "type": "reference", "name": "PromiseLike.then" } } ], "implementationOf": { "type": "reference", "name": "PromiseLike.then" } }, { "id": 628, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 44, "character": 2 } ], "signatures": [ { "id": 629, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 613, "name": "Result" } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 611 ] }, { "title": "Properties", "kind": 1024, "children": [ 619, 622, 617, 627, 615, 618, 620, 621, 616 ] }, { "title": "Methods", "kind": 2048, "children": [ 630, 628 ] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 6, "character": 30 } ], "typeParameter": [ { "id": 642, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedBy": [ { "type": "reference", "id": 490, "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 658, "typeArguments": [ { "type": "reference", "id": 613, "name": "Result" } ], "name": "PostgrestSingleResponse" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] }, { "id": 1, "name": "PostgrestClient", "kind": 128, "kindString": "Class", "flags": {}, "comment": { "shortText": "PostgREST client." }, "children": [ { "id": 2, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 41, "character": 2 } ], "signatures": [ { "id": 3, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { "shortText": "Creates a PostgREST client." }, "typeParameter": [ { "id": 4, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 5, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } } ] } } }, { "id": 6, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 5, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "extendsType": { "type": "reference", "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ], "parameters": [ { "id": 7, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "URL of the PostgREST endpoint" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 8, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 9, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 12, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 50, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 13, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 14, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Custom fetch\n" }, "parameters": [ { "id": 15, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 16, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 10, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Custom headers" }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 48, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 11, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Postgres schema to switch to" }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 49, "character": 6 } ], "type": { "type": "reference", "id": 5, "name": "SchemaName" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 12, 10, 11 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 1, "typeArguments": [ { "type": "reference", "id": 4, "name": "Database" }, { "type": "reference", "id": 5, "name": "SchemaName" }, { "type": "reference", "id": 6, "name": "Schema" } ], "name": "default" } } ] }, { "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 29, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 24, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 27, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 19, "name": "schemaName", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 28, "character": 2 } ], "type": { "type": "reference", "id": 5, "name": "SchemaName" } }, { "id": 17, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 26, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 25, "name": "from", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 59, "character": 2 } ], "signatures": [ { "id": 26, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { "id": 27, "name": "TableName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 28, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericTable" } } ], "parameters": [ { "id": 29, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table or view name to query\n" }, "type": { "type": "reference", "id": 27, "name": "TableName" } } ], "type": { "type": "reference", "id": 57, "typeArguments": [ { "type": "reference", "id": 6, "name": "Schema" }, { "type": "reference", "id": 28, "name": "Table" }, { "type": "reference", "id": 27, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", "id": 28, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { "id": 30, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 31, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "reference", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 31 ] } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } ], "name": "default" } }, { "id": 32, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { "id": 33, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 34, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericView" } } ], "parameters": [ { "id": 35, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table or view name to query\n" }, "type": { "type": "reference", "id": 33, "name": "ViewName" } } ], "type": { "type": "reference", "id": 57, "typeArguments": [ { "type": "reference", "id": 6, "name": "Schema" }, { "type": "reference", "id": 34, "name": "View" }, { "type": "reference", "id": 33, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", "id": 34, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { "id": 36, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 37, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "reference", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 37 ] } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } ], "name": "default" } }, { "id": 38, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a query on a table or a view." }, "parameters": [ { "id": 39, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The table or view name to query\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 57, "typeArguments": [ { "type": "reference", "id": 6, "name": "Schema" }, { "type": "intrinsic", "name": "any" }, { "type": "intrinsic", "name": "any" }, { "type": "intrinsic", "name": "unknown" } ], "name": "default" } } ] }, { "id": 44, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 123, "character": 2 } ], "signatures": [ { "id": 45, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a function call." }, "typeParameter": [ { "id": 46, "name": "FunctionName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 47, "name": "Function_", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericFunction" } } ], "parameters": [ { "id": 48, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The function name to call" }, "type": { "type": "reference", "id": 46, "name": "FunctionName" } }, { "id": 49, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The arguments to pass to the function call" }, "type": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Args" }, "objectType": { "type": "reference", "id": 47, "name": "Function_" } }, "defaultValue": "{}" }, { "id": 50, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 51, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 53, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 134, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 52, "name": "head", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." }, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 133, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 53, 52 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 6, "name": "Schema" }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Returns" }, "objectType": { "type": "reference", "id": 47, "name": "Function_" } }, "extendsType": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } }, "trueType": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } } }, "extendsType": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "never" } }, "falseType": { "type": "intrinsic", "name": "never" } }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Returns" }, "objectType": { "type": "reference", "id": 47, "name": "Function_" } }, { "type": "intrinsic", "name": "unknown" }, { "type": "intrinsic", "name": "unknown" } ], "name": "default" } } ] }, { "id": 40, "name": "schema", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 88, "character": 2 } ], "signatures": [ { "id": 41, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Select a schema to query or perform an function (rpc) call.", "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" }, "typeParameter": [ { "id": 42, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 43, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The schema to query\n" }, "type": { "type": "reference", "id": 42, "name": "DynamicSchema" } } ], "type": { "type": "reference", "id": 1, "typeArguments": [ { "type": "reference", "id": 4, "name": "Database" }, { "type": "reference", "id": 42, "name": "DynamicSchema" }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 42, "name": "DynamicSchema" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "extendsType": { "type": "reference", "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 2 ] }, { "title": "Properties", "kind": 1024, "children": [ 20, 18, 19, 17 ] }, { "title": "Methods", "kind": 2048, "children": [ 25, 44, 40 ] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 17, "character": 21 } ], "typeParameter": [ { "id": 54, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" }, "default": { "type": "intrinsic", "name": "any" } }, { "id": 55, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" }, "type": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } } ] }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "id": 4, "name": "Database" } } ] } } }, { "id": 56, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 5, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "extendsType": { "type": "reference", "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 5, "name": "SchemaName" }, "objectType": { "type": "reference", "id": 4, "name": "Database" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ] }, { "id": 144, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 145, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 146, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 147, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 148, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 149, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 150, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 151, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 152, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 149, "name": "Result" } ], "name": "default" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 492, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", "id": 491, "name": "default.constructor" } }, { "id": 462, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" }, "inheritedFrom": { "type": "reference", "id": 582, "name": "default.body" } }, { "id": 465, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 466, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 467, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 468, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 469, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } }, "inheritedFrom": { "type": "reference", "id": 585, "name": "default.fetch" } }, { "id": 460, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, "inheritedFrom": { "type": "reference", "id": 580, "name": "default.headers" } }, { "id": 470, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 590, "name": "default.isMaybeSingle" } }, { "id": 458, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 9, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 578, "name": "default.method" } }, { "id": 461, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 581, "name": "default.schema" } }, { "id": 463, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false", "inheritedFrom": { "type": "reference", "id": 583, "name": "default.shouldThrowOnError" } }, { "id": 464, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 584, "name": "default.signal" } }, { "id": 459, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 579, "name": "default.url" } }, { "id": 430, "name": "abortSignal", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 180, "character": 2 } ], "signatures": [ { "id": 431, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { "id": 432, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The AbortSignal to use for the fetch request\n" }, "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 551, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", "id": 550, "name": "default.abortSignal" } }, { "id": 274, "name": "containedBy", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 281, "character": 2 } ], "signatures": [ { "id": 275, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." }, "typeParameter": [ { "id": 276, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 277, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", "id": 276, "name": "ColumnName" } }, { "id": 278, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 276, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 279, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." }, "parameters": [ { "id": 280, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 281, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 266, "name": "contains", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 254, "character": 2 } ], "signatures": [ { "id": 267, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." }, "typeParameter": [ { "id": 268, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 269, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", "id": 268, "name": "ColumnName" } }, { "id": 270, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 268, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 271, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." }, "parameters": [ { "id": 272, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 273, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 439, "name": "csv", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 221, "character": 2 } ], "signatures": [ { "id": 440, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 560, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", "id": 559, "name": "default.csv" } }, { "id": 153, "name": "eq", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 35, "character": 2 } ], "signatures": [ { "id": 154, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is equal to `value`.", "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" }, "typeParameter": [ { "id": 155, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 156, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 155, "name": "ColumnName" } }, { "id": 157, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 155, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } ], "qualifiedName": "NonNullable", "package": "typescript", "name": "NonNullable" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 158, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is equal to `value`.", "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" }, "typeParameter": [ { "id": 159, "name": "Value", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 160, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 161, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 159, "name": "Value" } ], "qualifiedName": "NonNullable", "package": "typescript", "name": "NonNullable" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 443, "name": "explain", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 255, "character": 2 } ], "signatures": [ { "id": 444, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { "id": 445, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 446, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 447, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 263, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 450, "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on buffer usage\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 266, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 452, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 268, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "text" }, { "type": "literal", "value": "json" } ] } }, { "id": 449, "name": "settings", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 265, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 448, "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 264, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 451, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on WAL record generation\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 267, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 447, 450, 452, 449, 448, 451 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 610, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" }, { "type": "reference", "id": 610, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "name": "default" } ] }, "inheritedFrom": { "type": "reference", "id": 564, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", "id": 563, "name": "default.explain" } }, { "id": 369, "name": "filter", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 508, "character": 2 } ], "signatures": [ { "id": 370, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { "id": 371, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 372, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 371, "name": "ColumnName" } }, { "id": 373, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to filter with, following PostgREST syntax" }, "type": { "type": "union", "types": [ { "type": "reference", "name": "FilterOperator" }, { "type": "literal", "value": "not.eq" }, { "type": "literal", "value": "not.neq" }, { "type": "literal", "value": "not.gt" }, { "type": "literal", "value": "not.gte" }, { "type": "literal", "value": "not.lt" }, { "type": "literal", "value": "not.lte" }, { "type": "literal", "value": "not.like" }, { "type": "literal", "value": "not.ilike" }, { "type": "literal", "value": "not.is" }, { "type": "literal", "value": "not.in" }, { "type": "literal", "value": "not.cs" }, { "type": "literal", "value": "not.cd" }, { "type": "literal", "value": "not.sl" }, { "type": "literal", "value": "not.sr" }, { "type": "literal", "value": "not.nxl" }, { "type": "literal", "value": "not.nxr" }, { "type": "literal", "value": "not.adj" }, { "type": "literal", "value": "not.ov" }, { "type": "literal", "value": "not.fts" }, { "type": "literal", "value": "not.plfts" }, { "type": "literal", "value": "not.phfts" }, { "type": "literal", "value": "not.wfts" } ] } }, { "id": 374, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 375, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "parameters": [ { "id": 376, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 377, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to filter with, following PostgREST syntax" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 378, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 441, "name": "geojson", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 229, "character": 2 } ], "signatures": [ { "id": 442, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 562, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", "id": 561, "name": "default.geojson" } }, { "id": 170, "name": "gt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 66, "character": 2 } ], "signatures": [ { "id": 171, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than `value`." }, "typeParameter": [ { "id": 172, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 173, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 172, "name": "ColumnName" } }, { "id": 174, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 172, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 175, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than `value`." }, "parameters": [ { "id": 176, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 177, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 178, "name": "gte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 79, "character": 2 } ], "signatures": [ { "id": 179, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than or equal to `value`." }, "typeParameter": [ { "id": 180, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 181, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 180, "name": "ColumnName" } }, { "id": 182, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 180, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 183, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is greater than or equal to `value`." }, "parameters": [ { "id": 184, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 185, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 226, "name": "ilike", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 163, "character": 2 } ], "signatures": [ { "id": 227, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ { "id": 228, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 229, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 228, "name": "ColumnName" } }, { "id": 230, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 231, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "parameters": [ { "id": 232, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 233, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 234, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 176, "character": 2 } ], "signatures": [ { "id": 235, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "typeParameter": [ { "id": 236, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 237, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 236, "name": "ColumnName" } }, { "id": 238, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 239, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "parameters": [ { "id": 240, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 241, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 242, "name": "ilikeAnyOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 192, "character": 2 } ], "signatures": [ { "id": 243, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." }, "typeParameter": [ { "id": 244, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 245, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 244, "name": "ColumnName" } }, { "id": 246, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 247, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." }, "parameters": [ { "id": 248, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 249, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 258, "name": "in", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 230, "character": 2 } ], "signatures": [ { "id": 259, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is included in the `values` array." }, "typeParameter": [ { "id": 260, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 261, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 260, "name": "ColumnName" } }, { "id": 262, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values array to filter with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 260, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 263, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is included in the `values` array." }, "parameters": [ { "id": 264, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 265, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values array to filter with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 250, "name": "is", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 208, "character": 2 } ], "signatures": [ { "id": 251, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` IS `value`.", "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" }, "typeParameter": [ { "id": 252, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 253, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 252, "name": "ColumnName" } }, { "id": 254, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intersection", "types": [ { "type": "intersection", "types": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } }, { "type": "literal", "value": null } ] }, { "type": "intersection", "types": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } }, { "type": "literal", "value": false } ] }, { "type": "intersection", "types": [ { "type": "indexedAccess", "indexType": { "type": "reference", "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } }, { "type": "literal", "value": true } ] } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 255, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` IS `value`.", "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" }, "parameters": [ { "id": 256, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 257, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 202, "name": "like", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 118, "character": 2 } ], "signatures": [ { "id": 203, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-sensitively." }, "typeParameter": [ { "id": 204, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 205, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 204, "name": "ColumnName" } }, { "id": 206, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 207, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches `pattern` case-sensitively." }, "parameters": [ { "id": 208, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 209, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 210, "name": "likeAllOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 131, "character": 2 } ], "signatures": [ { "id": 211, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." }, "typeParameter": [ { "id": 212, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 213, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 212, "name": "ColumnName" } }, { "id": 214, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 215, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." }, "parameters": [ { "id": 216, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 217, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 218, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 147, "character": 2 } ], "signatures": [ { "id": 219, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." }, "typeParameter": [ { "id": 220, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 221, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 220, "name": "ColumnName" } }, { "id": 222, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 223, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." }, "parameters": [ { "id": 224, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 225, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 415, "name": "limit", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 131, "character": 2 } ], "signatures": [ { "id": 416, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by `count`." }, "parameters": [ { "id": 417, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 418, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 419, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 420, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 420, 421 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 536, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", "id": 535, "name": "default.limit" } }, { "id": 186, "name": "lt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 92, "character": 2 } ], "signatures": [ { "id": 187, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than `value`." }, "typeParameter": [ { "id": 188, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 189, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 188, "name": "ColumnName" } }, { "id": 190, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 188, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 191, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than `value`." }, "parameters": [ { "id": 192, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 193, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 194, "name": "lte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 105, "character": 2 } ], "signatures": [ { "id": 195, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than or equal to `value`." }, "typeParameter": [ { "id": 196, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 197, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 196, "name": "ColumnName" } }, { "id": 198, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 196, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 199, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is less than or equal to `value`." }, "parameters": [ { "id": 200, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 201, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 346, "name": "match", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 441, "character": 2 } ], "signatures": [ { "id": 347, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." }, "typeParameter": [ { "id": 348, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 349, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 348, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", "id": 348, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 350, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." }, "parameters": [ { "id": 351, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 436, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 204, "character": 2 } ], "signatures": [ { "id": 437, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "typeParameter": [ { "id": 438, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 149, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 438, "name": "ResultOne" } ] } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 557, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", "id": 556, "name": "default.maybeSingle" } }, { "id": 162, "name": "neq", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 53, "character": 2 } ], "signatures": [ { "id": 163, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is not equal to `value`." }, "typeParameter": [ { "id": 164, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 165, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 164, "name": "ColumnName" } }, { "id": 166, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 164, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 167, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows where `column` is not equal to `value`." }, "parameters": [ { "id": 168, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 169, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 352, "name": "not", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 457, "character": 2 } ], "signatures": [ { "id": 353, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which doesn't satisfy the filter.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { "id": 354, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 355, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "reference", "id": 354, "name": "ColumnName" } }, { "id": 356, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" }, "type": { "type": "reference", "name": "FilterOperator" } }, { "id": 357, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 354, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 358, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which doesn't satisfy the filter.", "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "parameters": [ { "id": 359, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 360, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 361, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 362, "name": "or", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 496, "character": 2 } ], "signatures": [ { "id": 363, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Match only rows which satisfy at least one of the filters.", "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" }, "parameters": [ { "id": 364, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The filters to use, following PostgREST syntax" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 365, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 366, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 367, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `referencedTable` instead\n" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 501, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 368, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to filter on referenced tables\ninstead of the parent table" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 501, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 367, 368 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 384, "name": "order", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 55, "character": 2 } ], "signatures": [ { "id": 385, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ { "id": 386, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 387, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 386, "name": "ColumnName" } }, { "id": 388, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 390, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 391, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 392, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 390, 391, 392 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 505, "name": "default.order" } }, { "id": 393, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "parameters": [ { "id": 394, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 395, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 397, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 398, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 399, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 397, 398, 399 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 513, "name": "default.order" } }, { "id": 400, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "typeParameter": [ { "id": 401, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 402, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 401, "name": "ColumnName" } }, { "id": 403, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 405, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 407, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 406, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 405, 407, 406 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 520, "name": "default.order" } }, { "id": 408, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "parameters": [ { "id": 409, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 410, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 412, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 414, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 413, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 412, 414, 413 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 528, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", "id": 504, "name": "default.order" } }, { "id": 322, "name": "overlaps", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 380, "character": 2 } ], "signatures": [ { "id": 323, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." }, "typeParameter": [ { "id": 324, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 325, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range column to filter on" }, "type": { "type": "reference", "id": 324, "name": "ColumnName" } }, { "id": 326, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "id": 324, "name": "ColumnName" }, "objectType": { "type": "reference", "id": 148, "name": "Row" } } } } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 327, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." }, "parameters": [ { "id": 328, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 329, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The array or range value to filter with\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } } ] } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 422, "name": "range", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 158, "character": 2 } ], "signatures": [ { "id": 423, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + to`).\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { "id": 424, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The starting index from which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 425, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 426, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 427, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 428, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 429, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 428, 429 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 543, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", "id": 542, "name": "default.range" } }, { "id": 314, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 365, "character": 2 } ], "signatures": [ { "id": 315, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." }, "typeParameter": [ { "id": 316, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 317, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 316, "name": "ColumnName" } }, { "id": 318, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 319, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." }, "parameters": [ { "id": 320, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 321, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 282, "name": "rangeGt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 307, "character": 2 } ], "signatures": [ { "id": 283, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." }, "typeParameter": [ { "id": 284, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 285, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 284, "name": "ColumnName" } }, { "id": 286, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 287, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." }, "parameters": [ { "id": 288, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 289, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 290, "name": "rangeGte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 321, "character": 2 } ], "signatures": [ { "id": 291, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." }, "typeParameter": [ { "id": 292, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 293, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 292, "name": "ColumnName" } }, { "id": 294, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 295, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." }, "parameters": [ { "id": 296, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 297, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 298, "name": "rangeLt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 336, "character": 2 } ], "signatures": [ { "id": 299, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." }, "typeParameter": [ { "id": 300, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 301, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 300, "name": "ColumnName" } }, { "id": 302, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 303, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." }, "parameters": [ { "id": 304, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 305, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 306, "name": "rangeLte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 350, "character": 2 } ], "signatures": [ { "id": 307, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." }, "typeParameter": [ { "id": 308, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 309, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "reference", "id": 308, "name": "ColumnName" } }, { "id": 310, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 311, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." }, "parameters": [ { "id": 312, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 313, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 455, "name": "returns", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 307, "character": 2 } ], "signatures": [ { "id": 456, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Override the type of the returned `data`." }, "typeParameter": [ { "id": 457, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "The new result type to override with\n" } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 457, "name": "NewResult" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 576, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", "id": 575, "name": "default.returns" } }, { "id": 453, "name": "rollback", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 293, "character": 2 } ], "signatures": [ { "id": 454, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Rollback the query.", "text": "`data` will still be returned, but the query is not committed.\n" }, "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 574, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", "id": 573, "name": "default.rollback" } }, { "id": 379, "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 21, "character": 2 } ], "signatures": [ { "id": 380, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a SELECT on the query result.", "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { "id": 381, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 382, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" }, { "type": "reference", "id": 381, "name": "Query" } ], "name": "GetResult" } } ], "parameters": [ { "id": 383, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", "id": 381, "name": "Query" } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", "id": 382, "name": "NewResultOne" } }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 500, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", "id": 499, "name": "default.select" } }, { "id": 433, "name": "single", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 191, "character": 2 } ], "signatures": [ { "id": 434, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "typeParameter": [ { "id": 435, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 149, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 435, "name": "ResultOne" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 554, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", "id": 553, "name": "default.single" } }, { "id": 330, "name": "textSearch", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 403, "character": 2 } ], "signatures": [ { "id": 331, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." }, "typeParameter": [ { "id": 332, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 333, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The text or tsvector column to filter on" }, "type": { "type": "reference", "id": 332, "name": "ColumnName" } }, { "id": 334, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The query text to match with" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 335, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 336, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 337, "name": "config", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The text search configuration to use" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 406, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 338, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Change how the `query` text is interpreted\n" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 406, "character": 33 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "plain" }, { "type": "literal", "value": "phrase" }, { "type": "literal", "value": "websearch" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 337, 338 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } }, { "id": 339, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." }, "parameters": [ { "id": 340, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The text or tsvector column to filter on" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 341, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The query text to match with" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 342, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 344, "name": "config", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The text search configuration to use" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 411, "character": 16 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 345, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Change how the `query` text is interpreted\n" }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 411, "character": 33 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "plain" }, { "type": "literal", "value": "phrase" }, { "type": "literal", "value": "websearch" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 344, 345 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 473, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 49, "character": 2 } ], "signatures": [ { "id": 474, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 475, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 658, "typeArguments": [ { "type": "reference", "id": 149, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 476, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 477, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 478, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 479, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 480, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 658, "typeArguments": [ { "type": "reference", "id": 149, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 481, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 482, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 483, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 484, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 476, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 476, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult1" }, { "type": "reference", "id": 476, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 594, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", "id": 593, "name": "default.then" } }, { "id": 471, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 44, "character": 2 } ], "signatures": [ { "id": 472, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 592, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", "id": 591, "name": "default.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 145 ] }, { "title": "Properties", "kind": 1024, "children": [ 462, 465, 460, 470, 458, 461, 463, 464, 459 ] }, { "title": "Methods", "kind": 2048, "children": [ 430, 274, 266, 439, 153, 443, 369, 441, 170, 178, 226, 234, 242, 258, 250, 202, 210, 218, 415, 186, 194, 346, 436, 162, 352, 362, 384, 322, 422, 314, 282, 290, 298, 306, 455, 453, 379, 433, 330, 473, 471 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 28, "character": 21 } ], "typeParameter": [ { "id": 485, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 486, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 487, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 488, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 489, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "extendedTypes": [ { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 147, "name": "Schema" }, { "type": "reference", "id": 148, "name": "Row" }, { "type": "reference", "id": 149, "name": "Result" }, { "type": "reference", "id": 150, "name": "RelationName" }, { "type": "reference", "id": 151, "name": "Relationships" } ], "name": "default" } ] }, { "id": 57, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 58, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 18, "character": 2 } ], "signatures": [ { "id": 59, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 60, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 61, "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "GenericTable" }, { "type": "reference", "name": "GenericView" } ] } }, { "id": 62, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 65, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 61, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { "id": 63, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 64, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "reference", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 64 ] } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } } ], "parameters": [ { "id": 66, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 67, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 68, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 71, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 27, "character": 6 } ], "type": { "type": "reflection", "declaration": { "id": 72, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 73, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 74, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 75, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 69, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 25, "character": 6 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 70, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 26, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 71, 69, 70 ] } ] } } } ], "type": { "type": "reference", "id": 57, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "reference", "id": 61, "name": "Relation" }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 80, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 16, "character": 2 } ], "type": { "type": "reflection", "declaration": { "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 82, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 83, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 84, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } } }, { "id": 77, "name": "headers", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 13, "character": 2 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 78, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 14, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 79, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 15, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } }, { "id": 76, "name": "url", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 12, "character": 2 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } }, { "id": 133, "name": "delete", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 357, "character": 2 } ], "signatures": [ { "id": 134, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a DELETE on the table or view.", "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "parameters": [ { "id": 135, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 136, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 137, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 360, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 137 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 94, "name": "insert", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 101, "character": 2 } ], "signatures": [ { "id": 95, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an INSERT into the table or view.", "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 96, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 97, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" }, "type": { "type": "reference", "id": 96, "name": "Row" } }, { "id": 98, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 99, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 100, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 104, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 100 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } }, { "id": 101, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an INSERT into the table or view.", "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 102, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 103, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 102, "name": "Row" } } }, { "id": 104, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 106, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 110, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 107, "name": "defaultToNull", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. Only applies for bulk\ninserts.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 111, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 106, 107 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 85, "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 57, "character": 2 } ], "signatures": [ { "id": 86, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a SELECT query on the table or view." }, "typeParameter": [ { "id": 87, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 88, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" }, { "type": "reference", "id": 87, "name": "Query" } ], "name": "GetResult" } } ], "parameters": [ { "id": 89, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`\n" }, "type": { "type": "reference", "id": 87, "name": "Query" } }, { "id": 90, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 91, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 93, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 67, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 92, "name": "head", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 66, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 93, 92 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "array", "elementType": { "type": "reference", "id": 88, "name": "ResultOne" } }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 126, "name": "update", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 309, "character": 2 } ], "signatures": [ { "id": 127, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an UPDATE on the table or view.", "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "typeParameter": [ { "id": 128, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 129, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to update with\n" }, "type": { "type": "reference", "id": 128, "name": "Row" } }, { "id": 130, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 131, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 132, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 314, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 132 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 108, "name": "upsert", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 184, "character": 2 } ], "signatures": [ { "id": 109, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 110, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 111, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { "type": "reference", "id": 110, "name": "Row" } }, { "id": 112, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 116, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 189, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 115, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 188, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 114, "name": "onConflict", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 187, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 116, 115, 114 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } }, { "id": 117, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { "id": 118, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "parameters": [ { "id": 119, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { "type": "array", "elementType": { "type": "reference", "id": 118, "name": "Row" } } }, { "id": 120, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters\n" }, "type": { "type": "reflection", "declaration": { "id": 121, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 124, "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 197, "character": 6 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 125, "name": "defaultToNull", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n`ignoreDuplicates: false`. This also only applies when doing bulk upserts.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 198, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 123, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 196, "character": 6 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 122, "name": "onConflict", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 195, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 124, 125, 123, 122 ] } ] } } } ], "type": { "type": "reference", "id": 144, "typeArguments": [ { "type": "reference", "id": 60, "name": "Schema" }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "id": 61, "name": "Relation" } }, { "type": "literal", "value": null }, { "type": "reference", "id": 62, "name": "RelationName" }, { "type": "reference", "id": 65, "name": "Relationships" } ], "name": "default" } } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 58 ] }, { "title": "Properties", "kind": 1024, "children": [ 80, 77, 78, 79, 76 ] }, { "title": "Methods", "kind": 2048, "children": [ 133, 94, 85, 126, 108 ] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 6, "character": 21 } ], "typeParameter": [ { "id": 138, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 139, "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "name": "GenericTable" }, { "type": "reference", "name": "GenericView" } ] } }, { "id": 140, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 143, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 61, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { "id": 141, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 142, "name": "Relationships", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 37 } ], "type": { "type": "inferred", "name": "R" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 142 ] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, "character": 35 } ] } }, "trueType": { "type": "reference", "name": "R" }, "falseType": { "type": "intrinsic", "name": "unknown" } } } ] }, { "id": 490, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { "id": 491, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { "id": 492, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { "id": 493, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 494, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 495, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 496, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 497, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 498, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 495, "name": "Result" } ], "name": "default" } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 612, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", "id": 611, "name": "default.constructor" } }, { "id": 582, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 13, "character": 12 } ], "type": { "type": "intrinsic", "name": "unknown" }, "inheritedFrom": { "type": "reference", "id": 619, "name": "default.body" } }, { "id": 585, "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 586, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 587, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 588, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "qualifiedName": "RequestInfo", "package": "typescript", "name": "RequestInfo" }, { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" } ] } }, { "id": 589, "name": "init", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "reference", "qualifiedName": "RequestInit", "package": "typescript", "name": "RequestInit" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", "qualifiedName": "Response", "package": "typescript", "name": "Response" } ], "qualifiedName": "Promise", "package": "typescript", "name": "Promise" } } ] } }, "inheritedFrom": { "type": "reference", "id": 622, "name": "default.fetch" } }, { "id": 580, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 11, "character": 12 } ], "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" }, "inheritedFrom": { "type": "reference", "id": 617, "name": "default.headers" } }, { "id": 590, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 17, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "id": 627, "name": "default.isMaybeSingle" } }, { "id": 578, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 9, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 615, "name": "default.method" } }, { "id": 581, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 12, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 618, "name": "default.schema" } }, { "id": 583, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 14, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false", "inheritedFrom": { "type": "reference", "id": 620, "name": "default.shouldThrowOnError" } }, { "id": 584, "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 15, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" }, "inheritedFrom": { "type": "reference", "id": 621, "name": "default.signal" } }, { "id": 579, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 10, "character": 12 } ], "type": { "type": "reference", "qualifiedName": "URL", "package": "typescript", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 616, "name": "default.url" } }, { "id": 550, "name": "abortSignal", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 180, "character": 2 } ], "signatures": [ { "id": 551, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { "id": 552, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The AbortSignal to use for the fetch request\n" }, "type": { "type": "reference", "qualifiedName": "AbortSignal", "package": "typescript", "name": "AbortSignal" } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 559, "name": "csv", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 221, "character": 2 } ], "signatures": [ { "id": 560, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" } } ] }, { "id": 563, "name": "explain", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 255, "character": 2 } ], "signatures": [ { "id": 564, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { "id": 565, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 566, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 567, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 263, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 570, "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on buffer usage\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 266, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 572, "name": "format", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 268, "character": 4 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "text" }, { "type": "literal", "value": "json" } ] } }, { "id": 569, "name": "settings", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 265, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 568, "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 264, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 571, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, include information on WAL record generation\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 267, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 567, 570, 572, 569, 568, 571 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 610, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "default" }, { "type": "reference", "id": 610, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } } ], "name": "default" } ] } } ] }, { "id": 561, "name": "geojson", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 229, "character": 2 } ], "signatures": [ { "id": 562, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } ], "name": "default" } } ] }, { "id": 535, "name": "limit", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 131, "character": 2 } ], "signatures": [ { "id": 536, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by `count`." }, "parameters": [ { "id": 537, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 538, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 539, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 540, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 541, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 136, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 540, 541 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 556, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 204, "character": 2 } ], "signatures": [ { "id": 557, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "typeParameter": [ { "id": 558, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 495, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "id": 438, "name": "ResultOne" } ] } ], "name": "default" } } ] }, { "id": 504, "name": "order", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 55, "character": 2 } ], "signatures": [ { "id": 505, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ { "id": 506, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 507, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 386, "name": "ColumnName" } }, { "id": 508, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 510, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 511, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 512, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 57, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 510, 511, 512 ] } ] } } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } }, { "id": 513, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "parameters": [ { "id": 514, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 515, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 516, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 517, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, the result will be in ascending order" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 518, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 519, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to order a referenced table by\nits columns" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 61, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 517, 518, 519 ] } ] } } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } }, { "id": 520, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "typeParameter": [ { "id": 521, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 522, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "reference", "id": 401, "name": "ColumnName" } }, { "id": 523, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 524, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 525, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 527, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 59 } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 526, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 68, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 525, 527, 526 ] } ] } } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } }, { "id": 528, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Order the query result by `column`.", "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", "tags": [ { "tag": "deprecated", "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" } ] }, "parameters": [ { "id": 529, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The column to order by" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 530, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "Named parameters" }, "type": { "type": "reflection", "declaration": { "id": 531, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 532, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 534, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 59 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 533, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 75, "character": 37 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 532, 534, 533 ] } ] } } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 542, "name": "range", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 158, "character": 2 } ], "signatures": [ { "id": 543, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + to`).\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { "id": 544, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The starting index from which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 545, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 546, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { "id": 547, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 548, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 549, "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 164, "character": 32 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 548, 549 ] } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 575, "name": "returns", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 307, "character": 2 } ], "signatures": [ { "id": 576, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Override the type of the returned `data`." }, "typeParameter": [ { "id": 577, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { "shortText": "The new result type to override with\n" } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 457, "name": "NewResult" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 573, "name": "rollback", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 293, "character": 2 } ], "signatures": [ { "id": 574, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Rollback the query.", "text": "`data` will still be returned, but the query is not committed.\n" }, "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 499, "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 21, "character": 2 } ], "signatures": [ { "id": 500, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Perform a SELECT on the query result.", "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { "id": 501, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 502, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" }, { "type": "reference", "id": 381, "name": "Query" } ], "name": "GetResult" } } ], "parameters": [ { "id": 503, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", "id": 381, "name": "Query" } } ], "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", "id": 382, "name": "NewResultOne" } }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" } } ] }, { "id": 553, "name": "single", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 191, "character": 2 } ], "signatures": [ { "id": 554, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Return `data` as a single object instead of an array of objects.", "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "typeParameter": [ { "id": 555, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "id": 495, "name": "Result" }, "extendsType": { "type": "array", "elementType": { "type": "reference", "name": "ResultOne" } }, "trueType": { "type": "reference", "name": "ResultOne" }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 435, "name": "ResultOne" } ], "name": "default" } } ] }, { "id": 593, "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 49, "character": 2 } ], "signatures": [ { "id": 594, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { "id": 595, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", "id": 658, "typeArguments": [ { "type": "reference", "id": 495, "name": "Result" } ], "name": "PostgrestSingleResponse" } }, { "id": 596, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 597, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 598, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 599, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 600, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 658, "typeArguments": [ { "type": "reference", "id": 495, "name": "Result" } ], "name": "PostgrestSingleResponse" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult1" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 475, "name": "TResult1" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } }, { "id": 601, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 602, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { "id": 603, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { "id": 604, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 476, "name": "TResult2" }, { "type": "reference", "typeArguments": [ { "type": "reference", "id": 476, "name": "TResult2" } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" } ] } } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 475, "name": "TResult1" }, { "type": "reference", "id": 476, "name": "TResult2" } ] } ], "qualifiedName": "PromiseLike", "package": "typescript", "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 631, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", "id": 630, "name": "default.then" } }, { "id": 591, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 44, "character": 2 } ], "signatures": [ { "id": 592, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 490, "typeArguments": [ { "type": "reference", "id": 493, "name": "Schema" }, { "type": "reference", "id": 494, "name": "Row" }, { "type": "reference", "id": 495, "name": "Result" }, { "type": "reference", "id": 496, "name": "RelationName" }, { "type": "reference", "id": 497, "name": "Relationships" } ], "name": "default" }, "inheritedFrom": { "type": "reference", "id": 629, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", "id": 628, "name": "default.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 491 ] }, { "title": "Properties", "kind": 1024, "children": [ 582, 585, 580, 590, 578, 581, 583, 584, 579 ] }, { "title": "Methods", "kind": 2048, "children": [ 550, 559, 563, 561, 535, 556, 504, 542, 575, 573, 499, 553, 593, 591 ] } ], "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 5, "character": 21 } ], "typeParameter": [ { "id": 605, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "name": "GenericSchema" } }, { "id": 606, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "qualifiedName": "Record", "package": "typescript", "name": "Record" } }, { "id": 607, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { "id": 608, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 609, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "extendedTypes": [ { "type": "reference", "id": 610, "typeArguments": [ { "type": "reference", "id": 495, "name": "Result" } ], "name": "default" } ], "extendedBy": [ { "type": "reference", "id": 144, "name": "PostgrestFilterBuilder" } ] }, { "id": 645, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 648, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 32, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 647, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 31, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 646, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 30, "character": 2 } ], "type": { "type": "reference", "id": 662, "name": "PostgrestError" } }, { "id": 649, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 21, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.status" } }, { "id": 650, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 648, 647, 646, 649, 650 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 29, "character": 17 } ], "extendedTypes": [ { "type": "reference", "name": "PostgrestResponseBase" } ] }, { "id": 651, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 654, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 27, "character": 2 } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 653, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 26, "character": 2 } ], "type": { "type": "reference", "id": 657, "name": "T" } }, { "id": 652, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 25, "character": 2 } ], "type": { "type": "literal", "value": null } }, { "id": 655, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 21, "character": 2 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.status" } }, { "id": 656, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 22, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 654, 653, 652, 655, 656 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 24, "character": 17 } ], "typeParameter": [ { "id": 657, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "extendedTypes": [ { "type": "reference", "name": "PostgrestResponseBase" } ] }, { "id": 662, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 12 } ], "type": { "type": "reflection", "declaration": { "id": 663, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 667, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 12, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 665, "name": "details", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 10, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 666, "name": "hint", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 11, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 664, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 9, "character": 2 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 667, 665, 666, 664 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 8, "character": 29 } ] } } }, { "id": 660, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 39, "character": 12 } ], "typeParameter": [ { "id": 661, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reference", "id": 658, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "id": 661, "name": "T" }, { "type": "literal", "value": null } ] } ], "name": "PostgrestSingleResponse" } }, { "id": 643, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 40, "character": 12 } ], "typeParameter": [ { "id": 644, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "reference", "id": 658, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "id": 644, "name": "T" } } ], "name": "PostgrestSingleResponse" } }, { "id": 658, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 38, "character": 12 } ], "typeParameter": [ { "id": 659, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 651, "typeArguments": [ { "type": "reference", "id": 659, "name": "T" } ], "name": "PostgrestResponseSuccess" }, { "type": "reference", "id": 645, "name": "PostgrestResponseFailure" } ] } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 610, 1, 144, 57, 490 ] }, { "title": "Interfaces", "kind": 256, "children": [ 645, 651 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ 662, 660, 643, 658 ] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }