{ "id": 0, "name": "@supabase/postgrest-js", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 443, "name": "\"PostgrestClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/PostgrestClient.ts", "children": [ { "id": 444, "name": "PostgrestClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 451, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Creates a PostgREST client." }, "signatures": [ { "id": 452, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Creates a PostgREST client." }, "parameters": [ { "id": 453, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "URL of the PostgREST endpoint." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 454, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 455, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 456, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Custom headers." }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 19, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 457, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 458, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 459, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 460, "name": "schema", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Postgres schema to switch to.\n" }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 19, "character": 26 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 456, 460 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 18, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 444, "name": "PostgrestClient" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 8, "character": 17 } ] }, { "id": 446, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 7, "character": 9 } ], "type": { "type": "reflection", "declaration": { "id": 447, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 448, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 449, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 7, "character": 10 } ] } } }, { "id": 450, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 8, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 445, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 6, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 461, "name": "auth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 462, "name": "auth", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Authenticates the request with JWT." }, "parameters": [ { "id": 463, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The JWT token to use.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 31, "character": 6 } ] }, { "id": 464, "name": "from", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 465, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a table operation." }, "typeParameter": [ { "id": 466, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 467, "name": "table", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The table name to operate on.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 322, "typeArguments": [ { "type": "typeParameter", "name": "T", "default": { "type": "intrinsic", "name": "any" } } ], "name": "PostgrestQueryBuilder" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 41, "character": 6 } ] }, { "id": 468, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 469, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a stored procedure call." }, "typeParameter": [ { "id": 470, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 471, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The function name to call." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 472, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "The parameters to pass to the function call." }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "object" } ] } }, { "id": 473, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 474, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 475, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Count algorithm to use to count rows in a table.\n" }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 57, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] }, "defaultValue": "null" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 475 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 55, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T", "default": { "type": "intrinsic", "name": "any" } } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 53, "character": 5 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 451 ] }, { "title": "Properties", "kind": 1024, "children": [ 446, 450, 445 ] }, { "title": "Methods", "kind": 2048, "children": [ 461, 464, 468 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 5, "character": 36 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 444 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 1, "character": 0 } ] }, { "id": 476, "name": "\"index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/index.ts", "sources": [ { "fileName": "index.ts", "line": 1, "character": 0 } ] }, { "id": 126, "name": "\"lib/PostgrestFilterBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestFilterBuilder.ts", "children": [ { "id": 127, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 128, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 303, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 304, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 305, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } } ], "type": { "type": "reference", "id": 127, "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 40 } ], "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 214, "name": "adj", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeAdjacent()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 306, "character": 5 } ], "type": { "type": "reference", "id": 210, "name": "rangeAdjacent" }, "defaultValue": "this.rangeAdjacent" }, { "id": 301, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] }, "inheritedFrom": { "type": "reference", "id": 36, "name": "PostgrestBuilder.body" } }, { "id": 189, "name": "cd", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `containedBy()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 231, "character": 4 } ], "type": { "type": "reference", "id": 185, "name": "containedBy" }, "defaultValue": "this.containedBy" }, { "id": 184, "name": "cs", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `contains()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 207, "character": 4 } ], "type": { "type": "reference", "id": 180, "name": "contains" }, "defaultValue": "this.contains" }, { "id": 296, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 297, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 298, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 299, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 294, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "GET" }, { "type": "stringLiteral", "value": "HEAD" }, { "type": "stringLiteral", "value": "POST" }, { "type": "stringLiteral", "value": "PATCH" }, { "type": "stringLiteral", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 29, "name": "PostgrestBuilder.method" } }, { "id": 204, "name": "nxl", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeGte()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 276, "character": 5 } ], "type": { "type": "reference", "id": 200, "name": "rangeGte" }, "defaultValue": "this.rangeGte" }, { "id": 209, "name": "nxr", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeLte()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 291, "character": 5 } ], "type": { "type": "reference", "id": 205, "name": "rangeLte" }, "defaultValue": "this.rangeLte" }, { "id": 219, "name": "ov", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `overlaps()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 327, "character": 4 } ], "type": { "type": "reference", "id": 215, "name": "overlaps" }, "defaultValue": "this.overlaps" }, { "id": 300, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 302, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 194, "name": "sl", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeLt()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 246, "character": 4 } ], "type": { "type": "reference", "id": 190, "name": "rangeLt" }, "defaultValue": "this.rangeLt" }, { "id": 199, "name": "sr", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `rangeGt()` instead." } ] }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 261, "character": 4 } ], "type": { "type": "reference", "id": 195, "name": "rangeGt" }, "defaultValue": "this.rangeGt" }, { "id": 295, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 185, "name": "containedBy", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 186, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose json, array, or range value on the stated `column` is\ncontained by the specified `value`." }, "parameters": [ { "id": 187, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 188, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } }, { "type": "intrinsic", "name": "object" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 216, "character": 13 } ] }, { "id": 180, "name": "contains", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 181, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose json, array, or range value on the stated `column`\ncontains the values specified in `value`." }, "parameters": [ { "id": 182, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 183, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } }, { "type": "intrinsic", "name": "object" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 191, "character": 10 } ] }, { "id": 292, "name": "csv", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 293, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set the response type to CSV." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 63, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 98, "name": "PostgrestTransformBuilder.csv" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 126, "character": 5 } ], "inheritedFrom": { "type": "reference", "id": 98, "name": "PostgrestTransformBuilder.csv" } }, { "id": 140, "name": "eq", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 141, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value on the stated `column` exactly matches the\nspecified `value`." }, "parameters": [ { "id": 142, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 143, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 63, "character": 4 } ] }, { "id": 256, "name": "filter", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 257, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose `column` satisfies the filter." }, "parameters": [ { "id": 258, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 259, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The operator to filter with." }, "type": { "type": "reference", "id": 320, "name": "FilterOperator" } }, { "id": 260, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 430, "character": 8 } ] }, { "id": 228, "name": "fts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 229, "name": "fts", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose tsvector value on the stated `column` matches\nto_tsquery(`query`).", "tags": [ { "tag": "deprecated", "text": "Use `textSearch()` instead.\n" } ] }, "parameters": [ { "id": 230, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 231, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 232, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 234, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 369, "character": 46 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 234 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 369, "character": 37 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 369, "character": 5 } ] }, { "id": 148, "name": "gt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 149, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value on the stated `column` is greater than the\nspecified `value`." }, "parameters": [ { "id": 150, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 151, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 87, "character": 4 } ] }, { "id": 152, "name": "gte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 153, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value on the stated `column` is greater than or\nequal to the specified `value`." }, "parameters": [ { "id": 154, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 155, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 99, "character": 5 } ] }, { "id": 168, "name": "ilike", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 169, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case insensitive)." }, "parameters": [ { "id": 170, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 171, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The pattern to filter with.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 147, "character": 7 } ] }, { "id": 176, "name": "in", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 177, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value on the stated `column` is found on the\nspecified `values`." }, "parameters": [ { "id": 178, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 179, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The values to filter with.\n" }, "type": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 171, "character": 4 } ] }, { "id": 172, "name": "is", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 173, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "A check for exact equality (null, true, false), finds all rows whose\nvalue on the stated `column` exactly match the specified `value`." }, "parameters": [ { "id": 174, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 175, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 159, "character": 4 } ] }, { "id": 164, "name": "like", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 165, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case sensitive)." }, "parameters": [ { "id": 166, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 167, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The pattern to filter with.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 135, "character": 6 } ] }, { "id": 275, "name": "limit", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 276, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result with the specified `count`." }, "parameters": [ { "id": 277, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The maximum no. of rows to limit to." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 278, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 279, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 280, "name": "foreignTable", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The foreign table to use (for foreign columns).\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 280 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 22 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 81, "name": "PostgrestTransformBuilder.limit" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 81, "name": "PostgrestTransformBuilder.limit" } }, { "id": 156, "name": "lt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 157, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value on the stated `column` is less than the\nspecified `value`." }, "parameters": [ { "id": 158, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 159, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 111, "character": 4 } ] }, { "id": 160, "name": "lte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 161, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value on the stated `column` is less than or equal\nto the specified `value`." }, "parameters": [ { "id": 162, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 163, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 123, "character": 5 } ] }, { "id": 261, "name": "match", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 262, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose columns match the specified `query` object." }, "parameters": [ { "id": 263, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The object to filter with, with column names as keys mapped\n to their filter values.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 441, "character": 7 } ] }, { "id": 290, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 291, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 65, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestMaybeSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 96, "name": "PostgrestTransformBuilder.maybeSingle" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 102, "character": 13 } ], "inheritedFrom": { "type": "reference", "id": 96, "name": "PostgrestTransformBuilder.maybeSingle" } }, { "id": 144, "name": "neq", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 145, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose value on the stated `column` doesn't match the\nspecified `value`." }, "parameters": [ { "id": 146, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 147, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 75, "character": 5 } ] }, { "id": 129, "name": "not", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 130, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows which doesn't satisfy the filter." }, "parameters": [ { "id": 131, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 132, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The operator to filter with." }, "type": { "type": "reference", "id": 320, "name": "FilterOperator" } }, { "id": 133, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 39, "character": 5 } ] }, { "id": 134, "name": "or", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 135, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows satisfying at least one of the filters." }, "parameters": [ { "id": 136, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The filters to use, separated by commas." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 137, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 139, "name": "foreignTable", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The foreign table to use (if `column` is a foreign column).\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 50, "character": 36 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 139 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 50, "character": 21 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 50, "character": 4 } ] }, { "id": 267, "name": "order", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 268, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Orders the result with the specified `column`." }, "parameters": [ { "id": 269, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to order on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 270, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 272, "name": "ascending", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, the result will be in ascending order." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 43, "character": 15 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 274, "name": "foreignTable", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The foreign table to use (if `column` is a foreign column).\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 45, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 273, "name": "nullsFirst", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, `null`s appear first." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 44, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 272, 274, 273 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 41, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder.order" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 40, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder.order" } }, { "id": 215, "name": "overlaps", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 216, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose array or range value on the stated `column` overlaps\n(has a value in common) with the specified `value`." }, "parameters": [ { "id": 217, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 218, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The value to filter with.\n" }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } }, "objectType": { "type": "typeParameter", "name": "T" } } } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 315, "character": 10 } ] }, { "id": 242, "name": "phfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 243, "name": "phfts", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose tsvector value on the stated `column` matches\nphraseto_tsquery(`query`).", "tags": [ { "tag": "deprecated", "text": "Use `textSearch()` with `type: 'phrase'` instead.\n" } ] }, "parameters": [ { "id": 244, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 245, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 246, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 247, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 248, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 401, "character": 48 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 248 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 401, "character": 39 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 401, "character": 7 } ] }, { "id": 235, "name": "plfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 236, "name": "plfts", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose tsvector value on the stated `column` matches\nplainto_tsquery(`query`).", "tags": [ { "tag": "deprecated", "text": "Use `textSearch()` with `type: 'plain'` instead.\n" } ] }, "parameters": [ { "id": 237, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 238, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 239, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 241, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 385, "character": 48 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 241 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 385, "character": 39 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 385, "character": 7 } ] }, { "id": 281, "name": "range", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 282, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result to rows within the specified range, inclusive." }, "parameters": [ { "id": 283, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The starting index from which to limit the result, inclusive." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 284, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The last index to which to limit the result, inclusive." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 285, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 287, "name": "foreignTable", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The foreign table to use (for foreign columns).\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 48 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 287 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 33 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 87, "name": "PostgrestTransformBuilder.range" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 87, "name": "PostgrestTransformBuilder.range" } }, { "id": 210, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 211, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose range value on the stated `column` is adjacent to\nthe specified `range`." }, "parameters": [ { "id": 212, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 213, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The range to filter with.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 300, "character": 15 } ] }, { "id": 195, "name": "rangeGt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 196, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose range value on the stated `column` is strictly to\nthe right of the specified `range`." }, "parameters": [ { "id": 197, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 198, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The range to filter with.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 255, "character": 9 } ] }, { "id": 200, "name": "rangeGte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 201, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the left of the specified `range`." }, "parameters": [ { "id": 202, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 203, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The range to filter with.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 270, "character": 10 } ] }, { "id": 190, "name": "rangeLt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 191, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose range value on the stated `column` is strictly to the\nleft of the specified `range`." }, "parameters": [ { "id": 192, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 193, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The range to filter with.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 240, "character": 9 } ] }, { "id": 205, "name": "rangeLte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 206, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the right of the specified `range`." }, "parameters": [ { "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 208, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The range to filter with.\n" }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 285, "character": 10 } ] }, { "id": 264, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 265, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 266, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The columns to retrieve, separated by commas.\n" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"*\"" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 70, "name": "PostgrestTransformBuilder.select" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 13, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 70, "name": "PostgrestTransformBuilder.select" } }, { "id": 288, "name": "single", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 289, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 63, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 94, "name": "PostgrestTransformBuilder.single" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 92, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 94, "name": "PostgrestTransformBuilder.single" } }, { "id": 220, "name": "textSearch", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 221, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose text or tsvector value on the stated `column` matches\nthe tsquery in `query`." }, "parameters": [ { "id": 222, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 223, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 225, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 226, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use." }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 342, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 227, "name": "type", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The type of tsquery conversion to use on `query`.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 343, "character": 10 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "plain" }, { "type": "stringLiteral", "value": "phrase" }, { "type": "stringLiteral", "value": "websearch" } ] }, "defaultValue": "null" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 226, 227 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 340, "character": 18 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 338, "character": 12 } ] }, { "id": 308, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 309, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 310, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 311, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 312, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 314, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 315, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 316, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 317, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 318, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 319, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 79, "character": 18 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ] } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 306, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 307, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "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": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } }, { "id": 249, "name": "wfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 250, "name": "wfts", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose tsvector value on the stated `column` matches\nwebsearch_to_tsquery(`query`).", "tags": [ { "tag": "deprecated", "text": "Use `textSearch()` with `type: 'websearch'` instead.\n" } ] }, "parameters": [ { "id": 251, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to filter on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 252, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 253, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 254, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 255, "name": "config", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The text search configuration to use.\n" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 417, "character": 47 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 255 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 417, "character": 38 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 417, "character": 6 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 303 ] }, { "title": "Properties", "kind": 1024, "children": [ 214, 301, 189, 184, 296, 294, 204, 209, 219, 300, 302, 194, 199, 295 ] }, { "title": "Methods", "kind": 2048, "children": [ 185, 180, 292, 140, 256, 228, 148, 152, 168, 176, 172, 164, 275, 156, 160, 261, 290, 144, 129, 134, 267, 215, 242, 235, 281, 210, 195, 200, 190, 205, 264, 288, 220, 308, 306, 249 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 31, "character": 43 } ], "extendedTypes": [ { "type": "reference", "id": 68, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] }, { "id": 320, "name": "FilterOperator", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "Filters" }, "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 7, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "eq" }, { "type": "stringLiteral", "value": "neq" }, { "type": "stringLiteral", "value": "gt" }, { "type": "stringLiteral", "value": "gte" }, { "type": "stringLiteral", "value": "lt" }, { "type": "stringLiteral", "value": "lte" }, { "type": "stringLiteral", "value": "like" }, { "type": "stringLiteral", "value": "ilike" }, { "type": "stringLiteral", "value": "is" }, { "type": "stringLiteral", "value": "in" }, { "type": "stringLiteral", "value": "cs" }, { "type": "stringLiteral", "value": "cd" }, { "type": "stringLiteral", "value": "sl" }, { "type": "stringLiteral", "value": "sr" }, { "type": "stringLiteral", "value": "nxl" }, { "type": "stringLiteral", "value": "nxr" }, { "type": "stringLiteral", "value": "adj" }, { "type": "stringLiteral", "value": "ov" }, { "type": "stringLiteral", "value": "fts" }, { "type": "stringLiteral", "value": "plfts" }, { "type": "stringLiteral", "value": "phfts" }, { "type": "stringLiteral", "value": "wfts" } ] } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 127 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ 320 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 321, "name": "\"lib/PostgrestQueryBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestQueryBuilder.ts", "children": [ { "id": 322, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 323, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 324, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 325, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 326, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 327, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 328, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 329, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 7, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 330, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 331, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 332, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 333, "name": "schema", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 7, "character": 26 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 329, 333 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 6, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 322, "name": "PostgrestQueryBuilder" }, "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 4, "character": 75 } ], "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 385, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] }, "inheritedFrom": { "type": "reference", "id": 36, "name": "PostgrestBuilder.body" } }, { "id": 380, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 381, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 382, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 383, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 378, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "GET" }, { "type": "stringLiteral", "value": "HEAD" }, { "type": "stringLiteral", "value": "POST" }, { "type": "stringLiteral", "value": "PATCH" }, { "type": "stringLiteral", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 29, "name": "PostgrestBuilder.method" } }, { "id": 384, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 386, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 379, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 372, "name": "delete", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 373, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs a DELETE on the table." }, "parameters": [ { "id": 374, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 375, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 377, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Count algorithm to use to count rows in a table.\n" }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 197, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] }, "defaultValue": "null" }, { "id": 376, "name": "returning", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, return the deleted row(s) in the response." }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 196, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 377, 376 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 195, "character": 9 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 195, "character": 8 } ] }, { "id": 341, "name": "insert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 342, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an INSERT into the table." }, "parameters": [ { "id": 343, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The values to insert." }, "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] } }, { "id": 344, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 345, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 347, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 68, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] } }, { "id": 346, "name": "returning", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 67, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 347, 346 ] } ] } } ] } } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } }, { "id": 348, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `upsert()` instead.\n" } ] }, "parameters": [ { "id": 349, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] } }, { "id": 350, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 355, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 80, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] } }, { "id": 353, "name": "onConflict", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 78, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 354, "name": "returning", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 79, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] } }, { "id": 352, "name": "upsert", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 77, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 355, 353, 354, 352 ] } ] } } ] } } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 64, "character": 8 }, { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 74, "character": 8 }, { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 83, "character": 8 } ] }, { "id": 334, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 335, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 336, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The columns to retrieve, separated by commas." }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"*\"" }, { "id": 337, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 338, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 340, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Count algorithm to use to count rows in a table.\n" }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 26, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] }, "defaultValue": "null" }, { "id": 339, "name": "head", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "When set to true, select will void data." }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 25, "character": 10 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 340, 339 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 23, "character": 18 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 22, "character": 8 } ] }, { "id": 389, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 390, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 391, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 392, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 393, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 394, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 395, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 396, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 397, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 399, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 400, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 79, "character": 18 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ] } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 387, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 388, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "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": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } }, { "id": 365, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 366, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPDATE on the table." }, "parameters": [ { "id": 367, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The values to update." }, "type": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } }, { "id": 368, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 371, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Count algorithm to use to count rows in a table.\n" }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 173, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] }, "defaultValue": "null" }, { "id": 370, "name": "returning", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "By default the updated record is returned. Set this to 'minimal' if you don't need this value." }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 172, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 371, 370 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 170, "character": 23 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 169, "character": 8 } ] }, { "id": 356, "name": "upsert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 357, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPSERT into the table." }, "parameters": [ { "id": 358, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The values to insert." }, "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] } }, { "id": 359, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 363, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Count algorithm to use to count rows in a table." }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 135, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] }, "defaultValue": "null" }, { "id": 364, "name": "ignoreDuplicates", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Specifies if duplicate rows should be ignored and not inserted.\n" }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 136, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 361, "name": "onConflict", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint." }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 133, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 362, "name": "returning", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "By default the new record is returned. Set this to 'minimal' if you don't need this value." }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 134, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 363, 364, 361, 362 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 131, "character": 38 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 130, "character": 8 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 324 ] }, { "title": "Properties", "kind": 1024, "children": [ 385, 380, 378, 384, 386, 379 ] }, { "title": "Methods", "kind": 2048, "children": [ 372, 341, 334, 389, 387, 365, 356 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 4, "character": 42 } ], "extendedTypes": [ { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 322 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 401, "name": "\"lib/PostgrestRpcBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestRpcBuilder.ts", "children": [ { "id": 402, "name": "PostgrestRpcBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 403, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 404, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 405, "name": "new PostgrestRpcBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 406, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 407, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 408, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 409, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 7, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 411, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 412, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 413, "name": "schema", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 7, "character": 26 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 409, 413 ] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 6, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 402, "name": "PostgrestRpcBuilder" }, "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 4, "character": 73 } ], "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 427, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] }, "inheritedFrom": { "type": "reference", "id": 36, "name": "PostgrestBuilder.body" } }, { "id": 422, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 423, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 424, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 425, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 420, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "GET" }, { "type": "stringLiteral", "value": "HEAD" }, { "type": "stringLiteral", "value": "POST" }, { "type": "stringLiteral", "value": "PATCH" }, { "type": "stringLiteral", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 29, "name": "PostgrestBuilder.method" } }, { "id": 426, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 428, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 421, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 414, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 415, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a stored procedure call." }, "parameters": [ { "id": 416, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "object" } ] } }, { "id": 417, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 418, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 419, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 21, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "null" }, { "type": "stringLiteral", "value": "exact" }, { "type": "stringLiteral", "value": "planned" }, { "type": "stringLiteral", "value": "estimated" } ] }, "defaultValue": "null" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 419 ] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 19, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 18, "character": 5 } ] }, { "id": 431, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 432, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 433, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 434, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 435, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 436, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 437, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 438, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 439, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 440, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 441, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 442, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 79, "character": 18 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ] } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 429, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 430, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "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": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 404 ] }, { "title": "Properties", "kind": 1024, "children": [ 427, 422, 420, 426, 428, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ 414, 431, 429 ] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 4, "character": 40 } ], "extendedTypes": [ { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 402 ] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 67, "name": "\"lib/PostgrestTransformBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestTransformBuilder.ts", "children": [ { "id": 68, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "comment": { "shortText": "Post-filters (transforms)" }, "typeParameter": [ { "id": 69, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 109, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 110, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 111, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } } ], "type": { "type": "reference", "id": 68, "name": "PostgrestTransformBuilder" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 40 } ], "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 107, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] }, "inheritedFrom": { "type": "reference", "id": 36, "name": "PostgrestBuilder.body" } }, { "id": 102, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 104, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 105, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 100, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "GET" }, { "type": "stringLiteral", "value": "HEAD" }, { "type": "stringLiteral", "value": "POST" }, { "type": "stringLiteral", "value": "PATCH" }, { "type": "stringLiteral", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "id": 29, "name": "PostgrestBuilder.method" } }, { "id": 106, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 108, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 101, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 98, "name": "csv", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 99, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set the response type to CSV." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 63, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 126, "character": 5 } ] }, { "id": 81, "name": "limit", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 82, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result with the specified `count`." }, "parameters": [ { "id": 83, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The maximum no. of rows to limit to." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 84, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 85, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 86, "name": "foreignTable", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The foreign table to use (for foreign columns).\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 86 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 22 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 7 } ] }, { "id": 96, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 97, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 65, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestMaybeSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 102, "character": 13 } ] }, { "id": 73, "name": "order", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 74, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Orders the result with the specified `column`." }, "parameters": [ { "id": 75, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The column to order on." }, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "typeParameter", "name": "T" } } }, { "id": 76, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 77, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 78, "name": "ascending", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, the result will be in ascending order." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 43, "character": 15 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 80, "name": "foreignTable", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The foreign table to use (if `column` is a foreign column).\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 45, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 79, "name": "nullsFirst", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "If `true`, `null`s appear first." }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 44, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 78, 80, 79 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 41, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 40, "character": 7 } ] }, { "id": 87, "name": "range", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 88, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result to rows within the specified range, inclusive." }, "parameters": [ { "id": 89, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The starting index from which to limit the result, inclusive." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 90, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The last index to which to limit the result, inclusive." }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 91, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 92, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 93, "name": "foreignTable", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "The foreign table to use (for foreign columns).\n" }, "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 48 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 93 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 33 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 7 } ] }, { "id": 70, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 71, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 72, "name": "columns", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The columns to retrieve, separated by commas.\n" }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"*\"" } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 13, "character": 8 } ] }, { "id": 94, "name": "single", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 95, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 63, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 92, "character": 8 } ] }, { "id": 114, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 115, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 116, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 117, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 118, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 119, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 120, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 121, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 122, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 124, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 125, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 79, "character": 18 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ] } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 112, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 113, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "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": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 109 ] }, { "title": "Properties", "kind": 1024, "children": [ 107, 102, 100, 106, 108, 101 ] }, { "title": "Methods", "kind": 2048, "children": [ 98, 81, 96, 73, 87, 70, 94, 114, 112 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 7, "character": 46 } ], "extendedTypes": [ { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } ], "extendedBy": [ { "type": "reference", "id": 127, "name": "PostgrestFilterBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 68 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 1, "name": "\"lib/types\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/types.ts", "children": [ { "id": 27, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true, "isAbstract": true }, "typeParameter": [ { "id": 28, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 38, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 39, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 40, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } } ], "type": { "type": "reference", "id": 27, "name": "PostgrestBuilder" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 40 } ] }, { "id": 36, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" }, { "type": "array", "elementType": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "Partial" } } ] } }, { "id": 31, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 32, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 33, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 34, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 21 } ] } } }, { "id": 29, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "GET" }, { "type": "stringLiteral", "value": "HEAD" }, { "type": "stringLiteral", "value": "POST" }, { "type": "stringLiteral", "value": "PATCH" }, { "type": "stringLiteral", "value": "DELETE" } ] } }, { "id": 35, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 37, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } }, { "id": 30, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" } }, { "id": 43, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 44, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 45, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 46, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 47, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 49, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 50, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 51, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 52, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 53, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 54, "name": "reason", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } }, { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ], "name": "PromiseLike" } ] } } ], "sources": [ { "fileName": "lib/types.ts", "line": 79, "character": 18 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "TResult1", "default": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } }, { "type": "typeParameter", "name": "TResult2", "default": { "type": "intrinsic", "name": "never" } } ] } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ] }, { "id": 41, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 42, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "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": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 38 ] }, { "title": "Properties", "kind": 1024, "children": [ 36, 31, 29, 35, 37, 30 ] }, { "title": "Methods", "kind": 2048, "children": [ 43, 41 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 51, "character": 38 } ], "extendedBy": [ { "type": "reference", "id": 68, "name": "PostgrestTransformBuilder" }, { "type": "reference", "id": 322, "name": "PostgrestQueryBuilder" }, { "type": "reference", "id": 402, "name": "PostgrestRpcBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] }, { "id": 2, "name": "PostgrestResponseBase", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { "shortText": "Response format", "text": "{@link https://github.com/supabase/supabase-js/issues/32}\n" }, "children": [ { "id": 3, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 21, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 4, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 22, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 3, 4 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 20, "character": 31 } ], "extendedBy": [ { "type": "reference", "id": 5, "name": "PostgrestResponseSuccess" }, { "type": "reference", "id": 13, "name": "PostgrestResponseFailure" }, { "type": "reference", "id": 20, "name": "PostgrestSingleResponseSuccess" } ] }, { "id": 13, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { "id": 16, "name": "body", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 35, "character": 6 } ], "type": { "type": "intrinsic", "name": "null" } }, { "id": 17, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 36, "character": 7 } ], "type": { "type": "intrinsic", "name": "null" } }, { "id": 15, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 33, "character": 6 } ], "type": { "type": "intrinsic", "name": "null" } }, { "id": 14, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 32, "character": 7 } ], "type": { "type": "reference", "id": 55, "name": "PostgrestError" } }, { "id": 18, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 21, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 3, "name": "PostgrestResponseBase.status" } }, { "id": 19, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 22, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 4, "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 16, 17, 15, 14, 18, 19 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 31, "character": 34 } ], "extendedTypes": [ { "type": "reference", "id": 2, "name": "PostgrestResponseBase" } ] }, { "id": 5, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "typeParameter": [ { "id": 6, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "children": [ { "id": 9, "name": "body", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 28, "character": 6 } ], "type": { "type": "array", "elementType": { "type": "typeParameter", "name": "T" } } }, { "id": 10, "name": "count", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 29, "character": 7 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "number" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 8, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 27, "character": 6 } ], "type": { "type": "array", "elementType": { "type": "typeParameter", "name": "T" } } }, { "id": 7, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 26, "character": 7 } ], "type": { "type": "intrinsic", "name": "null" } }, { "id": 11, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 21, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 3, "name": "PostgrestResponseBase.status" } }, { "id": 12, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 22, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 4, "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 9, 10, 8, 7, 11, 12 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 25, "character": 34 } ], "extendedTypes": [ { "type": "reference", "id": 2, "name": "PostgrestResponseBase" } ] }, { "id": 20, "name": "PostgrestSingleResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "typeParameter": [ { "id": 21, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": {} } ], "children": [ { "id": 24, "name": "body", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 44, "character": 6 } ], "type": { "type": "typeParameter", "name": "T" } }, { "id": 23, "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 42, "character": 6 } ], "type": { "type": "typeParameter", "name": "T" } }, { "id": 22, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 41, "character": 7 } ], "type": { "type": "intrinsic", "name": "null" } }, { "id": 25, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 21, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "id": 3, "name": "PostgrestResponseBase.status" } }, { "id": 26, "name": "statusText", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "lib/types.ts", "line": 22, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "id": 4, "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 24, 23, 22, 25, 26 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 40, "character": 40 } ], "extendedTypes": [ { "type": "reference", "id": 2, "name": "PostgrestResponseBase" } ] }, { "id": 55, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, "sources": [ { "fileName": "lib/types.ts", "line": 8, "character": 26 } ], "type": { "type": "reflection", "declaration": { "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 60, "name": "code", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 12, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 58, "name": "details", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 10, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 59, "name": "hint", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 11, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 57, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 9, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 60, 58, 59, 57 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 8, "character": 28 } ] } } }, { "id": 65, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 66, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "sources": [ { "fileName": "lib/types.ts", "line": 49, "character": 40 } ], "type": { "type": "reference", "id": 63, "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "T" }, { "type": "intrinsic", "name": "null" } ] } ], "name": "PostgrestSingleResponse" } }, { "id": 61, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 62, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "sources": [ { "fileName": "lib/types.ts", "line": 38, "character": 29 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 5, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponseSuccess" }, { "type": "reference", "id": 13, "name": "PostgrestResponseFailure" } ] } }, { "id": 63, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 64, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "sources": [ { "fileName": "lib/types.ts", "line": 46, "character": 35 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 20, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestSingleResponseSuccess" }, { "type": "reference", "id": 13, "name": "PostgrestResponseFailure" } ] } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 27 ] }, { "title": "Interfaces", "kind": 256, "children": [ 2, 13, 5, 20 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ 55, 65, 61, 63 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [ 443, 476, 126, 321, 401, 67, 1 ] } ] }