{ "schemaVersion": "2.0", "id": 992, "name": "@probitas-test/client-mongodb", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a MongoDB client designed for integration testing of applications using MongoDB.\n\n## Features\n\n- **CRUD Operations**: find, findOne, insertOne, insertMany, updateOne, updateMany, deleteOne, deleteMany\n- **Aggregations**: Full aggregation pipeline support\n- **Sessions**: Transaction support with sessions\n- **Type Safety**: Generic type parameters for document types\n- **Resource Management**: Implements " }, { "kind": "code", "text": "`AsyncDisposable`" }, { "kind": "text", "text": " for proper cleanup\n\n## Installation\n\n" }, { "kind": "code", "text": "```bash\nnpm install @probitas-test/client-mongodb\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\nconst client = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\n\n// Get a collection\nconst users = client.collection<{ name: string; email: string }>(\"users\");\n\n// Insert a document\nconst insertResult = await users.insertOne({ name: \"Alice\", email: \"alice@example.com\" });\nif (insertResult.ok) {\n console.log(\"Inserted ID:\", insertResult.insertedId);\n} else {\n console.error(\"Insert failed:\", insertResult.error.message);\n}\n\n// Find documents\nconst findResult = await users.find({ name: \"Alice\" });\nif (findResult.ok) {\n console.log(\"Found:\", findResult.docs);\n}\n\n// Find one document\nconst user = await users.findOne({ name: \"Alice\" });\nif (user.ok) {\n console.log(\"User:\", user.doc);\n}\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Transactions\n\n" }, { "kind": "code", "text": "```ts\nimport { createMongoClient, type MongoSession } from \"@probitas-test/client-mongodb\";\n\nconst client = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\n\nawait client.transaction(async (session: MongoSession) => {\n const accounts = client.collection(\"accounts\");\n await accounts.updateOne(\n { _id: \"from\" },\n { $inc: { balance: -100 } },\n );\n await accounts.updateOne(\n { _id: \"to\" },\n { $inc: { balance: 100 } },\n );\n});\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Using with " }, { "kind": "code", "text": "`using`" }, { "kind": "text", "text": " Statement\n\n" }, { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\nawait using client = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\n\nconst result = await client.collection(\"test\").findOne({});\nconsole.log(result?.doc);\n// Client automatically closed when block exits\n```" }, { "kind": "text", "text": "\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [" }, { "kind": "code", "text": "`@probitas-test/client`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client) | Core utilities and types |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [MongoDB](https://www.mongodb.com/)" } ] }, "children": [ { "id": 1111, "name": "MongoConnectionError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a MongoDB connection cannot be established." } ] }, "children": [ { "id": 1112, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 1113, "name": "MongoConnectionError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 1114, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1115, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1100, "name": "MongoErrorOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": 1111, "name": "MongoConnectionError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": 1104, "name": "MongoError.constructor" } } ], "overwrites": { "type": "reference", "target": 1103, "name": "MongoError.constructor" } }, { "id": 1118, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1109, "name": "MongoError.code" } }, { "id": 1117, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 1110, "name": "MongoError.kind" } }, { "id": 1116, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "MongoConnectionError" }, "defaultValue": "\"MongoConnectionError\"", "overwrites": { "type": "reference", "target": 1108, "name": "MongoError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1129, "name": "MongoDuplicateKeyError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a duplicate key constraint is violated." } ] }, "children": [ { "id": 1130, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 1131, "name": "MongoDuplicateKeyError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 1132, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1133, "name": "keyPattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ], "name": "Record", "package": "typescript" } }, { "id": 1134, "name": "keyValue", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "id": 1135, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1100, "name": "MongoErrorOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": 1129, "name": "MongoDuplicateKeyError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": 1104, "name": "MongoError.constructor" } } ], "overwrites": { "type": "reference", "target": 1103, "name": "MongoError.constructor" } }, { "id": 1140, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1109, "name": "MongoError.code" } }, { "id": 1138, "name": "keyPattern", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ], "name": "Record", "package": "typescript" } }, { "id": 1139, "name": "keyValue", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "id": 1137, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "duplicate_key" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 1110, "name": "MongoError.kind" } }, { "id": 1136, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "MongoDuplicateKeyError" }, "defaultValue": "\"MongoDuplicateKeyError\"", "overwrites": { "type": "reference", "target": 1108, "name": "MongoError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1102, "name": "MongoError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for MongoDB client errors." } ] }, "children": [ { "id": 1103, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 1104, "name": "MongoError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 1105, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1106, "name": "kind", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"mongo\"" }, { "id": 1107, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1100, "name": "MongoErrorOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } } ], "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } }, { "id": 1109, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1110, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 1108, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"MongoError\"", "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "ClientError" }, "name": "ClientError", "package": "@probitas-test/client" } ], "extendedBy": [ { "type": "reference", "target": 1111, "name": "MongoConnectionError" }, { "type": "reference", "target": 1119, "name": "MongoQueryError" }, { "type": "reference", "target": 1129, "name": "MongoDuplicateKeyError" }, { "type": "reference", "target": 1141, "name": "MongoValidationError" }, { "type": "reference", "target": 1151, "name": "MongoWriteError" }, { "type": "reference", "target": 1169, "name": "MongoNotFoundError" } ] }, { "id": 1169, "name": "MongoNotFoundError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a document is not found (for firstOrThrow, lastOrThrow)." } ] }, "children": [ { "id": 1170, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 1171, "name": "MongoNotFoundError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 1172, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1173, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1100, "name": "MongoErrorOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": 1169, "name": "MongoNotFoundError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": 1104, "name": "MongoError.constructor" } } ], "overwrites": { "type": "reference", "target": 1103, "name": "MongoError.constructor" } }, { "id": 1176, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1109, "name": "MongoError.code" } }, { "id": 1175, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "not_found" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 1110, "name": "MongoError.kind" } }, { "id": 1174, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "MongoNotFoundError" }, "defaultValue": "\"MongoNotFoundError\"", "overwrites": { "type": "reference", "target": 1108, "name": "MongoError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1119, "name": "MongoQueryError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a MongoDB query fails." } ] }, "children": [ { "id": 1120, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 1121, "name": "MongoQueryError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 1122, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1123, "name": "collection", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1124, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1100, "name": "MongoErrorOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": 1119, "name": "MongoQueryError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": 1104, "name": "MongoError.constructor" } } ], "overwrites": { "type": "reference", "target": 1103, "name": "MongoError.constructor" } }, { "id": 1128, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1109, "name": "MongoError.code" } }, { "id": 1127, "name": "collection", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1126, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "query" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 1110, "name": "MongoError.kind" } }, { "id": 1125, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "MongoQueryError" }, "defaultValue": "\"MongoQueryError\"", "overwrites": { "type": "reference", "target": 1108, "name": "MongoError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1141, "name": "MongoValidationError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when document validation fails." } ] }, "children": [ { "id": 1142, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 1143, "name": "MongoValidationError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 1144, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1145, "name": "validationErrors", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } }, { "id": 1146, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1100, "name": "MongoErrorOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": 1141, "name": "MongoValidationError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": 1104, "name": "MongoError.constructor" } } ], "overwrites": { "type": "reference", "target": 1103, "name": "MongoError.constructor" } }, { "id": 1150, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1109, "name": "MongoError.code" } }, { "id": 1148, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "validation" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 1110, "name": "MongoError.kind" } }, { "id": 1147, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "MongoValidationError" }, "defaultValue": "\"MongoValidationError\"", "overwrites": { "type": "reference", "target": 1108, "name": "MongoError.name" } }, { "id": 1149, "name": "validationErrors", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "extendedTypes": [ { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1151, "name": "MongoWriteError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a write operation fails." } ] }, "children": [ { "id": 1152, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 1153, "name": "MongoWriteError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 1154, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1155, "name": "writeErrors", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 1156, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1158, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1157, "name": "index", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1159, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] } } } } }, { "id": 1160, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1100, "name": "MongoErrorOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": 1151, "name": "MongoWriteError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": 1104, "name": "MongoError.constructor" } } ], "overwrites": { "type": "reference", "target": 1103, "name": "MongoError.constructor" } }, { "id": 1168, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1109, "name": "MongoError.code" } }, { "id": 1162, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "write" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 1110, "name": "MongoError.kind" } }, { "id": 1161, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "MongoWriteError" }, "defaultValue": "\"MongoWriteError\"", "overwrites": { "type": "reference", "target": 1108, "name": "MongoError.name" } }, { "id": 1163, "name": "writeErrors", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 1164, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1166, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1165, "name": "index", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1167, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] } } } } } ], "extendedTypes": [ { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1082, "name": "MongoClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB client interface" } ] }, "children": [ { "id": 1083, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 1025, "name": "MongoClientConfig", "package": "@probitas-test/client-mongodb" } }, { "id": 1098, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1099, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1084, "name": "collection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1085, "name": "collection", "variant": "signature", "kind": 4096, "flags": {}, "typeParameters": [ { "id": 1086, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 1006, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Document", "package": "@probitas-test/client-mongodb" }, "default": { "type": "reference", "target": 1006, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "parameters": [ { "id": 1087, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1037, "typeArguments": [ { "type": "reference", "target": 1086, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoCollection", "package": "@probitas-test/client-mongodb" } } ] }, { "id": 1088, "name": "db", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1089, "name": "db", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1090, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1082, "name": "MongoClient", "package": "@probitas-test/client-mongodb" } } ] }, { "id": 1091, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1092, "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "typeParameters": [ { "id": 1093, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 1094, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1095, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { "id": 1096, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1097, "name": "session", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1032, "name": "MongoSession", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1093, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1093, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 1025, "name": "MongoClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB client configuration." } ], "blockTags": [ { "tag": "@example", "name": "Using a connection string", "content": [ { "kind": "code", "text": "```ts\nconst config: MongoClientConfig = {\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n};\n```" } ] }, { "tag": "@example", "name": "Using a configuration object", "content": [ { "kind": "code", "text": "```ts\nconst config: MongoClientConfig = {\n url: {\n host: \"localhost\",\n port: 27017,\n username: \"admin\",\n password: \"secret\",\n authSource: \"admin\",\n },\n database: \"testdb\",\n};\n```" } ] } ] }, "children": [ { "id": 1027, "name": "database", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Database name to connect to." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1031, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": 997, "name": "MongoOptions.retry" } }, { "id": 1030, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 996, "name": "MongoOptions.signal" } }, { "id": 1028, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "If true, throws errors instead of returning them in the result.\nIf false (default), errors are returned in the result object." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": 994, "name": "MongoOptions.throwOnError" } }, { "id": 1029, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 995, "name": "MongoOptions.timeout" } }, { "id": 1026, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "MongoDB connection URL or configuration object." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 998, "name": "MongoConnectionConfig", "package": "@probitas-test/client-mongodb" } ] } } ], "extendedTypes": [ { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1037, "name": "MongoCollection", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB collection interface" } ] }, "children": [ { "id": 1073, "name": "aggregate", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1074, "name": "aggregate", "variant": "signature", "kind": 4096, "flags": {}, "typeParameters": [ { "id": 1075, "name": "R", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1038, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoCollection.T", "refersToTypeParameter": true } } ], "parameters": [ { "id": 1076, "name": "pipeline", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 1006, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Document", "package": "@probitas-test/client-mongodb" } } }, { "id": 1077, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1645, "typeArguments": [ { "type": "reference", "target": 1075, "name": "R", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1078, "name": "countDocuments", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1079, "name": "countDocuments", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1080, "name": "filter", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1008, "name": "Filter", "package": "@probitas-test/client-mongodb" } }, { "id": 1081, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1640, "name": "MongoCountResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1069, "name": "deleteMany", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1070, "name": "deleteMany", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1071, "name": "filter", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1008, "name": "Filter", "package": "@probitas-test/client-mongodb" } }, { "id": 1072, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1641, "name": "MongoDeleteResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1065, "name": "deleteOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1066, "name": "deleteOne", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1067, "name": "filter", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1008, "name": "Filter", "package": "@probitas-test/client-mongodb" } }, { "id": 1068, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1641, "name": "MongoDeleteResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1039, "name": "find", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1040, "name": "find", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1041, "name": "filter", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1008, "name": "Filter", "package": "@probitas-test/client-mongodb" } }, { "id": 1042, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1010, "name": "MongoFindOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1645, "typeArguments": [ { "type": "reference", "target": 1038, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoCollection.T", "refersToTypeParameter": true } ], "name": "MongoFindResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1043, "name": "findOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1044, "name": "findOne", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1045, "name": "filter", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1008, "name": "Filter", "package": "@probitas-test/client-mongodb" } }, { "id": 1046, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1643, "typeArguments": [ { "type": "reference", "target": 1038, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoCollection.T", "refersToTypeParameter": true } ], "name": "MongoFindOneResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1051, "name": "insertMany", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1052, "name": "insertMany", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1053, "name": "docs", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1038, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoCollection.T", "refersToTypeParameter": true }, { "type": "literal", "value": "_id" } ], "name": "Omit", "package": "typescript" } } }, { "id": 1054, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1647, "name": "MongoInsertManyResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1047, "name": "insertOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1048, "name": "insertOne", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1049, "name": "doc", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1038, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoCollection.T", "refersToTypeParameter": true }, { "type": "literal", "value": "_id" } ], "name": "Omit", "package": "typescript" } }, { "id": 1050, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1648, "name": "MongoInsertOneResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1060, "name": "updateMany", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1061, "name": "updateMany", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1062, "name": "filter", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1008, "name": "Filter", "package": "@probitas-test/client-mongodb" } }, { "id": 1063, "name": "update", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1009, "name": "UpdateFilter", "package": "@probitas-test/client-mongodb" } }, { "id": 1064, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1019, "name": "MongoUpdateOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1651, "name": "MongoUpdateResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1055, "name": "updateOne", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1056, "name": "updateOne", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1057, "name": "filter", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1008, "name": "Filter", "package": "@probitas-test/client-mongodb" } }, { "id": 1058, "name": "update", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1009, "name": "UpdateFilter", "package": "@probitas-test/client-mongodb" } }, { "id": 1059, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1019, "name": "MongoUpdateOptions", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1651, "name": "MongoUpdateResult", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] } ], "typeParameters": [ { "id": 1038, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ] }, { "id": 998, "name": "MongoConnectionConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB connection configuration.\n\nExtends CommonConnectionConfig with MongoDB-specific options." } ] }, "children": [ { "id": 1000, "name": "authSource", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Authentication database." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 999, "name": "database", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Database name to connect to." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1002, "name": "host", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Hostname or IP address." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"localhost\"\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.host" } }, { "id": 1005, "name": "password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Password for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.password" } }, { "id": 1003, "name": "port", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Port number. Each service has its own default." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.port" } }, { "id": 1001, "name": "replicaSet", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Replica set name." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1004, "name": "username", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Username for authentication." } ] }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonConnectionConfig.username" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonConnectionConfig" }, "name": "CommonConnectionConfig", "package": "@probitas-test/client" } ] }, { "id": 1326, "name": "MongoCountResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Count result with MongoDB error." } ] }, "children": [ { "id": 1330, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.count" } }, { "id": 1332, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoCountResultBase.duration" } }, { "id": 1329, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.error" } }, { "id": 1331, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:count" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoCountResultBase.kind" } }, { "id": 1328, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.ok" } }, { "id": 1327, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoCountResultBase" }, "name": "MongoCountResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1333, "name": "MongoCountResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Count result with connection failure." } ] }, "children": [ { "id": 1337, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.count" } }, { "id": 1339, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoCountResultBase.duration" } }, { "id": 1336, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1642, "name": "MongoFailureError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.error" } }, { "id": 1338, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:count" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoCountResultBase.kind" } }, { "id": 1335, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.ok" } }, { "id": 1334, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoCountResultBase" }, "name": "MongoCountResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1319, "name": "MongoCountResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful count result." } ] }, "children": [ { "id": 1323, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.count" } }, { "id": 1325, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoCountResultBase.duration" } }, { "id": 1322, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.error" } }, { "id": 1324, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:count" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoCountResultBase.kind" } }, { "id": 1321, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.ok" } }, { "id": 1320, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoCountResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoCountResultBase" }, "name": "MongoCountResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1305, "name": "MongoDeleteResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete result with MongoDB error." } ] }, "children": [ { "id": 1309, "name": "deletedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.deletedCount" } }, { "id": 1311, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.duration" } }, { "id": 1308, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.error" } }, { "id": 1310, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:delete" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.kind" } }, { "id": 1307, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.ok" } }, { "id": 1306, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoDeleteResultBase" }, "name": "MongoDeleteResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1312, "name": "MongoDeleteResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete result with connection failure." } ] }, "children": [ { "id": 1316, "name": "deletedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.deletedCount" } }, { "id": 1318, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.duration" } }, { "id": 1315, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1642, "name": "MongoFailureError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.error" } }, { "id": 1317, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:delete" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.kind" } }, { "id": 1314, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.ok" } }, { "id": 1313, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoDeleteResultBase" }, "name": "MongoDeleteResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1298, "name": "MongoDeleteResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful delete result." } ] }, "children": [ { "id": 1302, "name": "deletedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.deletedCount" } }, { "id": 1304, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.duration" } }, { "id": 1301, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.error" } }, { "id": 1303, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:delete" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.kind" } }, { "id": 1300, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.ok" } }, { "id": 1299, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoDeleteResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoDeleteResultBase" }, "name": "MongoDeleteResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1100, "name": "MongoErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for MongoDB errors." } ] }, "children": [ { "id": 1101, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2022.error.d.ts", "qualifiedName": "ErrorOptions" }, "name": "ErrorOptions", "package": "typescript" } ] }, { "id": 1210, "name": "MongoFindOneResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "FindOne result with MongoDB error." } ] }, "children": [ { "id": 1215, "name": "doc", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.doc", "package": "@probitas-test/client-mongodb" } }, { "id": 1217, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.duration" } }, { "id": 1214, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.error" } }, { "id": 1216, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:find-one" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.kind" } }, { "id": 1213, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.ok" } }, { "id": 1212, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.processed" } } ], "typeParameters": [ { "id": 1211, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoFindOneResultBase" }, "typeArguments": [ { "type": "reference", "target": 1211, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindOneResultError.T", "refersToTypeParameter": true } ], "name": "MongoFindOneResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1218, "name": "MongoFindOneResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "FindOne result with connection failure." } ] }, "children": [ { "id": 1223, "name": "doc", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.doc", "package": "@probitas-test/client-mongodb" } }, { "id": 1225, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.duration" } }, { "id": 1222, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1642, "name": "MongoFailureError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.error" } }, { "id": 1224, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:find-one" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.kind" } }, { "id": 1221, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.ok" } }, { "id": 1220, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.processed" } } ], "typeParameters": [ { "id": 1219, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoFindOneResultBase" }, "typeArguments": [ { "type": "reference", "target": 1219, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindOneResultFailure.T", "refersToTypeParameter": true } ], "name": "MongoFindOneResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1202, "name": "MongoFindOneResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful findOne result." } ] }, "children": [ { "id": 1207, "name": "doc", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1203, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindOneResultSuccess.T", "refersToTypeParameter": true }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.doc", "package": "@probitas-test/client-mongodb" } }, { "id": 1209, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.duration" } }, { "id": 1206, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.error" } }, { "id": 1208, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:find-one" }, "inheritedFrom": { "type": "reference", "target": 1216, "name": "MongoFindOneResultBase.kind", "package": "@probitas-test/client-mongodb" } }, { "id": 1205, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.ok" } }, { "id": 1204, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindOneResultBase.processed" } } ], "typeParameters": [ { "id": 1203, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoFindOneResultBase" }, "typeArguments": [ { "type": "reference", "target": 1203, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindOneResultSuccess.T", "refersToTypeParameter": true } ], "name": "MongoFindOneResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1010, "name": "MongoFindOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB find options" } ] }, "children": [ { "id": 1012, "name": "limit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1014, "name": "projection", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "union", "types": [ { "type": "literal", "value": 0 }, { "type": "literal", "value": 1 } ] } ], "name": "Record", "package": "typescript" } }, { "id": 1018, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": 997, "name": "MongoOptions.retry" } }, { "id": 1017, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 996, "name": "MongoOptions.signal" } }, { "id": 1013, "name": "skip", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1011, "name": "sort", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "union", "types": [ { "type": "literal", "value": -1 }, { "type": "literal", "value": 1 } ] } ], "name": "Record", "package": "typescript" } }, { "id": 1015, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "If true, throws errors instead of returning them in the result.\nIf false (default), errors are returned in the result object." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": 994, "name": "MongoOptions.throwOnError" } }, { "id": 1016, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 995, "name": "MongoOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1186, "name": "MongoFindResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Find result with MongoDB error." } ] }, "children": [ { "id": 1191, "name": "docs", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 1187, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindResultError.T", "refersToTypeParameter": true } } }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.docs", "package": "@probitas-test/client-mongodb" } }, { "id": 1193, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindResultBase.duration" } }, { "id": 1190, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.error" } }, { "id": 1192, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:find" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindResultBase.kind" } }, { "id": 1189, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.ok" } }, { "id": 1188, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.processed" } } ], "typeParameters": [ { "id": 1187, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoFindResultBase" }, "typeArguments": [ { "type": "reference", "target": 1187, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindResultError.T", "refersToTypeParameter": true } ], "name": "MongoFindResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1194, "name": "MongoFindResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Find result with connection failure." } ] }, "children": [ { "id": 1199, "name": "docs", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.docs", "package": "@probitas-test/client-mongodb" } }, { "id": 1201, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindResultBase.duration" } }, { "id": 1198, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1642, "name": "MongoFailureError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.error" } }, { "id": 1200, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:find" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindResultBase.kind" } }, { "id": 1197, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.ok" } }, { "id": 1196, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.processed" } } ], "typeParameters": [ { "id": 1195, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoFindResultBase" }, "typeArguments": [ { "type": "reference", "target": 1195, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindResultFailure.T", "refersToTypeParameter": true } ], "name": "MongoFindResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1178, "name": "MongoFindResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful find result." } ] }, "children": [ { "id": 1183, "name": "docs", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 1179, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindResultSuccess.T", "refersToTypeParameter": true } } }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.docs", "package": "@probitas-test/client-mongodb" } }, { "id": 1185, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoFindResultBase.duration" } }, { "id": 1182, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.error" } }, { "id": 1184, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:find" }, "inheritedFrom": { "type": "reference", "target": 1192, "name": "MongoFindResultBase.kind", "package": "@probitas-test/client-mongodb" } }, { "id": 1181, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.ok" } }, { "id": 1180, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoFindResultBase.processed" } } ], "typeParameters": [ { "id": 1179, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoFindResultBase" }, "typeArguments": [ { "type": "reference", "target": 1179, "name": "T", "package": "@probitas-test/client-mongodb", "qualifiedName": "MongoFindResultSuccess.T", "refersToTypeParameter": true } ], "name": "MongoFindResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1255, "name": "MongoInsertManyResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "InsertMany result with MongoDB error." } ] }, "children": [ { "id": 1262, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.duration" } }, { "id": 1258, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.error" } }, { "id": 1260, "name": "insertedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.insertedCount" } }, { "id": 1259, "name": "insertedIds", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.insertedIds" } }, { "id": 1261, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:insert-many" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.kind" } }, { "id": 1257, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.ok" } }, { "id": 1256, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoInsertManyResultBase" }, "name": "MongoInsertManyResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1263, "name": "MongoInsertManyResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "InsertMany result with connection failure." } ] }, "children": [ { "id": 1270, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.duration" } }, { "id": 1266, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1642, "name": "MongoFailureError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.error" } }, { "id": 1268, "name": "insertedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.insertedCount" } }, { "id": 1267, "name": "insertedIds", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.insertedIds" } }, { "id": 1269, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:insert-many" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.kind" } }, { "id": 1265, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.ok" } }, { "id": 1264, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoInsertManyResultBase" }, "name": "MongoInsertManyResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1247, "name": "MongoInsertManyResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful insertMany result." } ] }, "children": [ { "id": 1254, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.duration" } }, { "id": 1250, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.error" } }, { "id": 1252, "name": "insertedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.insertedCount" } }, { "id": 1251, "name": "insertedIds", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.insertedIds" } }, { "id": 1253, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:insert-many" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.kind" } }, { "id": 1249, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.ok" } }, { "id": 1248, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertManyResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoInsertManyResultBase" }, "name": "MongoInsertManyResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1233, "name": "MongoInsertOneResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "InsertOne result with MongoDB error." } ] }, "children": [ { "id": 1239, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.duration" } }, { "id": 1236, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.error" } }, { "id": 1237, "name": "insertedId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.insertedId" } }, { "id": 1238, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:insert-one" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.kind" } }, { "id": 1235, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.ok" } }, { "id": 1234, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoInsertOneResultBase" }, "name": "MongoInsertOneResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1240, "name": "MongoInsertOneResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "InsertOne result with connection failure." } ] }, "children": [ { "id": 1246, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.duration" } }, { "id": 1243, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1642, "name": "MongoFailureError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.error" } }, { "id": 1244, "name": "insertedId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.insertedId" } }, { "id": 1245, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:insert-one" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.kind" } }, { "id": 1242, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.ok" } }, { "id": 1241, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoInsertOneResultBase" }, "name": "MongoInsertOneResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1226, "name": "MongoInsertOneResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful insertOne result." } ] }, "children": [ { "id": 1232, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.duration" } }, { "id": 1229, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.error" } }, { "id": 1230, "name": "insertedId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.insertedId" } }, { "id": 1231, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:insert-one" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.kind" } }, { "id": 1228, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.ok" } }, { "id": 1227, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoInsertOneResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoInsertOneResultBase" }, "name": "MongoInsertOneResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 993, "name": "MongoOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Common options with throwOnError support." } ] }, "children": [ { "id": 997, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.retry" } }, { "id": 996, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.signal" } }, { "id": 994, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "If true, throws errors instead of returning them in the result.\nIf false (default), errors are returned in the result object." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 995, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ], "extendedBy": [ { "type": "reference", "target": 1010, "name": "MongoFindOptions" }, { "type": "reference", "target": 1019, "name": "MongoUpdateOptions" }, { "type": "reference", "target": 1025, "name": "MongoClientConfig" } ] }, { "id": 1032, "name": "MongoSession", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB session interface (for transactions)" } ] }, "children": [ { "id": 1033, "name": "collection", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 1034, "name": "collection", "variant": "signature", "kind": 4096, "flags": {}, "typeParameters": [ { "id": 1035, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 1006, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Document", "package": "@probitas-test/client-mongodb" }, "default": { "type": "reference", "target": 1006, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "parameters": [ { "id": 1036, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1037, "typeArguments": [ { "type": "reference", "target": 1035, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoCollection", "package": "@probitas-test/client-mongodb" } } ] } ] }, { "id": 1019, "name": "MongoUpdateOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB update options" } ] }, "children": [ { "id": 1024, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": 997, "name": "MongoOptions.retry" } }, { "id": 1023, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 996, "name": "MongoOptions.signal" } }, { "id": 1021, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "If true, throws errors instead of returning them in the result.\nIf false (default), errors are returned in the result object." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": 994, "name": "MongoOptions.throwOnError" } }, { "id": 1022, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 995, "name": "MongoOptions.timeout" } }, { "id": 1020, "name": "upsert", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "boolean" } } ], "extendedTypes": [ { "type": "reference", "target": 993, "name": "MongoOptions", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1280, "name": "MongoUpdateResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Update result with MongoDB error." } ] }, "children": [ { "id": 1288, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.duration" } }, { "id": 1283, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.error" } }, { "id": 1287, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:update" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.kind" } }, { "id": 1284, "name": "matchedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.matchedCount" } }, { "id": 1285, "name": "modifiedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.modifiedCount" } }, { "id": 1282, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.ok" } }, { "id": 1281, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.processed" } }, { "id": 1286, "name": "upsertedId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.upsertedId" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoUpdateResultBase" }, "name": "MongoUpdateResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1289, "name": "MongoUpdateResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Update result with connection failure." } ] }, "children": [ { "id": 1297, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.duration" } }, { "id": 1292, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "reference", "target": 1642, "name": "MongoFailureError", "package": "@probitas-test/client-mongodb" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.error" } }, { "id": 1296, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:update" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.kind" } }, { "id": 1293, "name": "matchedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.matchedCount" } }, { "id": 1294, "name": "modifiedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.modifiedCount" } }, { "id": 1291, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.ok" } }, { "id": 1290, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.processed" } }, { "id": 1295, "name": "upsertedId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.upsertedId" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoUpdateResultBase" }, "name": "MongoUpdateResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1271, "name": "MongoUpdateResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful update result." } ] }, "children": [ { "id": 1279, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Operation duration in milliseconds.\n\nMeasured from operation start to completion, useful for performance analysis\nand timeout monitoring." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.duration" } }, { "id": 1274, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error that occurred during the operation (null if successful).\n\nContains the error when " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ". The specific error type depends\non the client kind (e.g., HttpError, GraphqlError, SqlError)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.error" } }, { "id": 1278, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nThe " }, { "kind": "code", "text": "`kind`" }, { "kind": "text", "text": " property is typed as " }, { "kind": "code", "text": "`string`" }, { "kind": "text", "text": " to allow client-specific packages\nto define their own result kinds without modifying this core package.\nSubinterfaces can narrow the type using literal types with " }, { "kind": "code", "text": "`as const`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": "mongo:update" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.kind" } }, { "id": 1275, "name": "matchedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.matchedCount" } }, { "id": 1276, "name": "modifiedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.modifiedCount" } }, { "id": 1273, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation succeeded.\n\nFor HTTP responses, this corresponds to status 200-299.\nFor database operations, this indicates successful execution.\nAlways " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " when " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " is " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.ok" } }, { "id": 1272, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the operation was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server received and processed the request (success or error response)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before reaching the server (network error, timeout, etc.)\n\nUse this to distinguish between \"server returned an error\" and \"couldn't reach server\"." } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.processed" } }, { "id": 1277, "name": "upsertedId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "MongoUpdateResultBase.upsertedId" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-mongodb", "packagePath": "result.ts", "qualifiedName": "MongoUpdateResultBase" }, "name": "MongoUpdateResultBase", "package": "@probitas-test/client-mongodb" } ] }, { "id": 1006, "name": "Document", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB document type" } ] }, "typeParameters": [ { "id": 1007, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 1007, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "Record", "package": "typescript" } }, { "id": 1008, "name": "Filter", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB filter type (simplified for compatibility with mongodb driver)\nAllows query operators like $gte, $lt, $in, etc." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1640, "name": "MongoCountResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Count result." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1319, "name": "MongoCountResultSuccess", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1326, "name": "MongoCountResultError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1333, "name": "MongoCountResultFailure", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1641, "name": "MongoDeleteResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete result." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1298, "name": "MongoDeleteResultSuccess", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1305, "name": "MongoDeleteResultError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1312, "name": "MongoDeleteResultFailure", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1642, "name": "MongoFailureError", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error types that indicate the operation was not processed.\nThese are errors that occur before the operation reaches the MongoDB server." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1111, "name": "MongoConnectionError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "AbortError" }, "name": "AbortError", "package": "@probitas-test/client" }, { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "TimeoutError" }, "name": "TimeoutError", "package": "@probitas-test/client" } ] } }, { "id": 1643, "name": "MongoFindOneResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "FindOne result." } ] }, "typeParameters": [ { "id": 1644, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1202, "typeArguments": [ { "type": "reference", "target": 1644, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindOneResultSuccess", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1210, "typeArguments": [ { "type": "reference", "target": 1644, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindOneResultError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1218, "typeArguments": [ { "type": "reference", "target": 1644, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindOneResultFailure", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1645, "name": "MongoFindResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Query result (find, aggregate)." } ] }, "typeParameters": [ { "id": 1646, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1006, "name": "Document", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1178, "typeArguments": [ { "type": "reference", "target": 1646, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindResultSuccess", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1186, "typeArguments": [ { "type": "reference", "target": 1646, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindResultError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1194, "typeArguments": [ { "type": "reference", "target": 1646, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindResultFailure", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1647, "name": "MongoInsertManyResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Insert many result." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1247, "name": "MongoInsertManyResultSuccess", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1255, "name": "MongoInsertManyResultError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1263, "name": "MongoInsertManyResultFailure", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1648, "name": "MongoInsertOneResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Insert one result." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1226, "name": "MongoInsertOneResultSuccess", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1233, "name": "MongoInsertOneResultError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1240, "name": "MongoInsertOneResultFailure", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1177, "name": "MongoOperationError", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error types that indicate a MongoDB operation error.\nThese are errors where the operation reached the server but failed." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1119, "name": "MongoQueryError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1129, "name": "MongoDuplicateKeyError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1141, "name": "MongoValidationError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1151, "name": "MongoWriteError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1169, "name": "MongoNotFoundError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1102, "name": "MongoError", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1649, "name": "MongoResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Union of all MongoDB result types." } ] }, "typeParameters": [ { "id": 1650, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1645, "typeArguments": [ { "type": "reference", "target": 1650, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindResult", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1648, "name": "MongoInsertOneResult", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1647, "name": "MongoInsertManyResult", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1651, "name": "MongoUpdateResult", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1641, "name": "MongoDeleteResult", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1643, "typeArguments": [ { "type": "reference", "target": 1650, "name": "T", "package": "@probitas-test/client-mongodb", "refersToTypeParameter": true } ], "name": "MongoFindOneResult", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1640, "name": "MongoCountResult", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1651, "name": "MongoUpdateResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Update result." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 1271, "name": "MongoUpdateResultSuccess", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1280, "name": "MongoUpdateResultError", "package": "@probitas-test/client-mongodb" }, { "type": "reference", "target": 1289, "name": "MongoUpdateResultFailure", "package": "@probitas-test/client-mongodb" } ] } }, { "id": 1009, "name": "UpdateFilter", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB update filter type (simplified for compatibility with mongodb driver)\nAllows update operators like $set, $inc, $unset, etc." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1637, "name": "createMongoClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 1638, "name": "createMongoClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new MongoDB client instance.\n\nThe client provides typed collection access, aggregation pipelines,\ntransaction support, and comprehensive CRUD operations." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise resolving to a new MongoDB client instance" } ] }, { "tag": "@example", "name": "Basic usage with connection string", "content": [ { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\nconst mongo = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\n\nconst users = mongo.collection<{ name: string; age: number }>(\"users\");\nconst result = await users.find({ age: { $gte: 18 } });\n\nif (result.ok) {\n console.log(result.docs[0]);\n} else {\n console.error(\"Error:\", result.error.message);\n}\n\nawait mongo.close();\n```" } ] }, { "tag": "@example", "name": "Using connection config object", "content": [ { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\nconst mongo = await createMongoClient({\n url: {\n host: \"localhost\",\n port: 27017,\n username: \"admin\",\n password: \"secret\",\n authSource: \"admin\",\n },\n database: \"testdb\",\n});\n\nawait mongo.close();\n```" } ] }, { "tag": "@example", "name": "Insert and query documents", "content": [ { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\ninterface User { name: string; age: number }\n\nconst mongo = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\nconst users = mongo.collection(\"users\");\n\n// Insert a document\nconst insertResult = await users.insertOne({ name: \"Alice\", age: 30 });\nif (insertResult.ok) {\n console.log(\"Inserted ID:\", insertResult.insertedId);\n}\n\n// Find documents with projection and sorting\nconst findResult = await users.find(\n { age: { $gte: 25 } },\n { sort: { name: 1 }, limit: 10 }\n);\nif (findResult.ok) {\n console.log(\"Found:\", findResult.docs.length);\n}\n\nawait mongo.close();\n```" } ] }, { "tag": "@example", "name": "Transaction with auto-commit/rollback", "content": [ { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\ninterface User { _id?: unknown; name: string; age: number }\n\nconst mongo = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\n\nawait mongo.transaction(async (session) => {\n const users = session.collection(\"users\");\n const insertResult = await users.insertOne({ name: \"Bob\", age: 25 });\n if (!insertResult.ok) throw insertResult.error;\n\n const updateResult = await users.updateOne(\n { name: \"Alice\" },\n { $inc: { age: 1 } }\n );\n if (!updateResult.ok) throw updateResult.error;\n});\n\nawait mongo.close();\n```" } ] }, { "tag": "@example", "name": "Aggregation pipeline", "content": [ { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\ninterface User { name: string; age: number; department: string }\n\nconst mongo = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\nconst users = mongo.collection(\"users\");\n\nconst result = await users.aggregate<{ _id: string; avgAge: number }>([\n { $group: { _id: \"$department\", avgAge: { $avg: \"$age\" } } },\n { $sort: { avgAge: -1 } },\n]);\nif (result.ok) {\n console.log(result.docs);\n}\n\nawait mongo.close();\n```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createMongoClient } from \"@probitas-test/client-mongodb\";\n\nawait using mongo = await createMongoClient({\n url: \"mongodb://localhost:27017\",\n database: \"testdb\",\n});\n\nconst result = await mongo.collection(\"users\").find({});\nif (result.ok) {\n console.log(result.docs);\n}\n// Client automatically closed when scope exits\n```" } ] } ] }, "parameters": [ { "id": 1639, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MongoDB client configuration" } ] }, "type": { "type": "reference", "target": 1025, "name": "MongoClientConfig", "package": "@probitas-test/client-mongodb" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1082, "name": "MongoClient", "package": "@probitas-test/client-mongodb" } ], "name": "Promise", "package": "typescript" } } ] } ], "packageName": "@probitas-test/client-mongodb", "packageVersion": "0.6.2" }