{ "schemaVersion": "2.0", "id": 4534, "name": "@probitas-test/client-sqs", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "AWS SQS client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides an AWS SQS client designed for integration testing of message-driven applications using Amazon Simple Queue Service.\n\n## Features\n\n- **Queue Management**: Create, delete, and purge queues\n- **Message Operations**: Send, receive, and delete messages (single and batch)\n- **Message Attributes**: Support for custom message attributes\n- **Emulator Compatible**: Works with ElasticMQ and other SQS-compatible servers\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-sqs\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createSqsClient } from \"@probitas-test/client-sqs\";\n\nconst client = await createSqsClient({\n region: \"us-east-1\",\n url: \"http://localhost:9324\", // ElasticMQ\n credentials: {\n accessKeyId: \"test\",\n secretAccessKey: \"test\",\n },\n});\n\n// Ensure queue exists\nconst queueResult = await client.ensureQueue(\"test-queue\");\nif (!queueResult.ok) throw new Error(\"Failed to ensure queue\");\n\n// Send a message\nconst sendResult = await client.send(\"Hello, World!\", {\n messageAttributes: {\n type: { dataType: \"String\", stringValue: \"greeting\" },\n },\n});\nif (!sendResult.ok) throw new Error(\"Failed to send message\");\nconsole.log(\"Message ID:\", sendResult.messageId);\n\n// Receive messages\nconst receiveResult = await client.receive({\n maxMessages: 10,\n waitTimeSeconds: 5,\n});\nif (!receiveResult.ok) throw new Error(\"Failed to receive messages\");\nconsole.log(\"Received:\", receiveResult.messages.length);\n\n// Delete message after processing\nfor (const msg of receiveResult.messages) {\n await client.delete(msg.receiptHandle);\n}\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Batch Operations\n\n" }, { "kind": "code", "text": "```ts\nimport { createSqsClient } from \"@probitas-test/client-sqs\";\n\nconst client = await createSqsClient({\n region: \"us-east-1\",\n url: \"http://localhost:9324\",\n credentials: { accessKeyId: \"test\", secretAccessKey: \"test\" },\n});\n\nconst queueResult = await client.ensureQueue(\"test-queue\");\nif (!queueResult.ok) throw new Error(\"Failed to ensure queue\");\n\n// Send batch messages\nawait client.sendBatch([\n { body: \"Message 1\", id: \"msg-1\" },\n { body: \"Message 2\", id: \"msg-2\" },\n { body: \"Message 3\", id: \"msg-3\" },\n]);\n\n// Delete batch messages\nconst receiveResult = await client.receive({ maxMessages: 10 });\nif (!receiveResult.ok) throw new Error(\"Failed to receive messages\");\nconst handles = receiveResult.messages.map((m) => m.receiptHandle);\nawait client.deleteBatch(handles);\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 { createSqsClient } from \"@probitas-test/client-sqs\";\n\nawait using client = await createSqsClient({\n region: \"us-east-1\",\n url: \"http://localhost:9324\",\n credentials: { accessKeyId: \"test\", secretAccessKey: \"test\" },\n});\n\nconst queue = await client.ensureQueue(\"test\");\nconsole.log(\"Queue URL:\", queue.queueUrl);\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| [" }, { "kind": "code", "text": "`@probitas-test/client-rabbitmq`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-rabbitmq) | RabbitMQ client |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [AWS SQS](https://aws.amazon.com/sqs/)\n- [ElasticMQ](https://github.com/softwaremill/elasticmq)" } ] }, "children": [ { "id": 5114, "name": "SqsBatchError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a batch operation partially fails." } ] }, "children": [ { "id": 5118, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 5130, "name": "SqsError.code" } }, { "id": 5117, "name": "failedCount", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 5116, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "batch" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 5131, "name": "SqsError.kind" } }, { "id": 5115, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqsBatchError" }, "defaultValue": "\"SqsBatchError\"", "overwrites": { "type": "reference", "target": 5129, "name": "SqsError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" } ] }, { "id": 4598, "name": "SqsBatchFailedEntry", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Failed batch entry." } ] }, "children": [ { "id": 4600, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4599, "name": "id", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4601, "name": "message", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 4580, "name": "SqsBatchMessage", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Batch message for sendBatch." } ] }, "children": [ { "id": 4582, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4583, "name": "delaySeconds", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4581, "name": "id", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4584, "name": "messageAttributes", "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": "reference", "target": 4560, "name": "SqsMessageAttribute", "package": "@probitas-test/client-sqs" } ], "name": "Record", "package": "typescript" } } ] }, { "id": 4614, "name": "SqsBatchOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for batch operations." } ] }, "children": [ { "id": 4618, "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": 4539, "name": "SqsOptions.retry" } }, { "id": 4617, "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": 4538, "name": "SqsOptions.signal" } }, { "id": 4615, "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": 4536, "name": "SqsOptions.throwOnError" } }, { "id": 4616, "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": 4537, "name": "SqsOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 4595, "name": "SqsBatchSuccessEntry", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful batch send entry." } ] }, "children": [ { "id": 4597, "name": "id", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4596, "name": "messageId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 4624, "name": "SqsClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQS client interface." } ] }, "children": [ { "id": 4625, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 4548, "name": "SqsClientConfig", "package": "@probitas-test/client-sqs" } }, { "id": 4626, "name": "queueUrl", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "The current queue URL. Can be set via config, ensureQueue(), or setQueueUrl()." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "undefined" } ] } }, { "id": 4660, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4661, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Close the client and release resources." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4649, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4650, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete a message from the queue." } ] }, "parameters": [ { "id": 4651, "name": "receiptHandle", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4652, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4609, "name": "SqsDeleteOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5108, "name": "SqsDeleteResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4653, "name": "deleteBatch", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4654, "name": "deleteBatch", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete multiple messages from the queue in a single request." } ] }, "parameters": [ { "id": 4655, "name": "receiptHandles", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 4656, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4614, "name": "SqsBatchOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5106, "name": "SqsDeleteBatchResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4634, "name": "deleteQueue", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4635, "name": "deleteQueue", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete a queue by URL." } ] }, "parameters": [ { "id": 4636, "name": "queueUrl", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4637, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4619, "name": "SqsDeleteQueueOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5107, "name": "SqsDeleteQueueResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4630, "name": "ensureQueue", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4631, "name": "ensureQueue", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Ensure a queue exists. Creates the queue if it doesn't exist.\nIf the queue already exists with the same attributes, returns the existing queue URL.\nAlso sets the queue URL for subsequent operations." } ] }, "parameters": [ { "id": 4632, "name": "queueName", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4633, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4602, "name": "SqsEnsureQueueOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5109, "name": "SqsEnsureQueueResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4657, "name": "purge", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4658, "name": "purge", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Purge all messages from the queue." } ] }, "parameters": [ { "id": 4659, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5108, "name": "SqsDeleteResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4646, "name": "receive", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4647, "name": "receive", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Receive messages from the queue." } ] }, "parameters": [ { "id": 4648, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4585, "name": "SqsReceiveOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5110, "name": "SqsReceiveResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4638, "name": "send", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4639, "name": "send", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Send a message to the queue." } ] }, "parameters": [ { "id": 4640, "name": "body", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4641, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4571, "name": "SqsSendOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5113, "name": "SqsSendResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4642, "name": "sendBatch", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4643, "name": "sendBatch", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Send multiple messages to the queue in a single request." } ] }, "parameters": [ { "id": 4644, "name": "messages", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 4580, "name": "SqsBatchMessage", "package": "@probitas-test/client-sqs" } } }, { "id": 4645, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 4614, "name": "SqsBatchOptions", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 5112, "name": "SqsSendBatchResult", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 4627, "name": "setQueueUrl", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 4628, "name": "setQueueUrl", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Set the queue URL for subsequent operations." } ] }, "parameters": [ { "id": 4629, "name": "queueUrl", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "void" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 4548, "name": "SqsClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQS client configuration." } ] }, "children": [ { "id": 4550, "name": "credentials", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "AWS credentials" } ] }, "type": { "type": "reflection", "declaration": { "id": 4551, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 4552, "name": "accessKeyId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4553, "name": "secretAccessKey", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 4554, "name": "queueUrl", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "SQS queue URL (optional - can be set later or used with ensureQueue)" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4549, "name": "region", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "AWS region" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4559, "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": 4539, "name": "SqsOptions.retry" } }, { "id": 4558, "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": 4538, "name": "SqsOptions.signal" } }, { "id": 4556, "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": 4536, "name": "SqsOptions.throwOnError" } }, { "id": 4557, "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": 4537, "name": "SqsOptions.timeout" } }, { "id": 4555, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "SQS endpoint URL (e.g., \"http://localhost:9324\" for ElasticMQ).\nCan be a string URL or a connection config object.\nOptional for real AWS (uses default endpoint), required for an emulator." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 4540, "name": "SqsConnectionConfig", "package": "@probitas-test/client-sqs" } ] } } ], "extendedTypes": [ { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 5119, "name": "SqsCommandError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when an SQS command fails." } ] }, "children": [ { "id": 5123, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 5130, "name": "SqsError.code" } }, { "id": 5121, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "command" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 5131, "name": "SqsError.kind" } }, { "id": 5120, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqsCommandError" }, "defaultValue": "\"SqsCommandError\"", "overwrites": { "type": "reference", "target": 5129, "name": "SqsError.name" } }, { "id": 5122, "name": "operation", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" } ] }, { "id": 4664, "name": "SqsCommandErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for SQS command errors." } ] }, "children": [ { "id": 4666, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 4663, "name": "SqsErrorOptions.code" } }, { "id": 4665, "name": "operation", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": 4662, "name": "SqsErrorOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 4540, "name": "SqsConnectionConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQS connection configuration.\n\nExtends CommonConnectionConfig with SQS-specific options." } ] }, "children": [ { "id": 4544, "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": 4547, "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": 4542, "name": "path", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Custom path (for emulators or custom endpoints)." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"\"\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4545, "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": 4541, "name": "protocol", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Protocol to use." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"https\"\n```" } ] } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "http" }, { "type": "literal", "value": "https" } ] } }, { "id": 4543, "name": "region", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "AWS region (required for AWS, optional for emulators)." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4546, "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": 5124, "name": "SqsConnectionError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when an SQS connection cannot be established." } ] }, "children": [ { "id": 5127, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 5130, "name": "SqsError.code" } }, { "id": 5126, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 5131, "name": "SqsError.kind" } }, { "id": 5125, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqsConnectionError" }, "defaultValue": "\"SqsConnectionError\"", "overwrites": { "type": "reference", "target": 5129, "name": "SqsError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" } ] }, { "id": 4931, "name": "SqsDeleteBatchResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Batch delete result with SQS error." } ] }, "children": [ { "id": 4938, "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": "SqsDeleteBatchResultBase.duration" } }, { "id": 4934, "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": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsDeleteBatchResultBase.error" } }, { "id": 4936, "name": "failed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "tuple" } } }, { "id": 4937, "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": "sqs:delete-batch" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteBatchResultBase.kind" } }, { "id": 4933, "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": "SqsDeleteBatchResultBase.ok" } }, { "id": 4932, "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": "SqsDeleteBatchResultBase.processed" } }, { "id": 4935, "name": "successful", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "tuple" } } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteBatchResultBase" }, "name": "SqsDeleteBatchResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4939, "name": "SqsDeleteBatchResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Batch delete result with connection failure." } ] }, "children": [ { "id": 4946, "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": "SqsDeleteBatchResultBase.duration" } }, { "id": 4942, "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": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsFailureError" }, "name": "SqsFailureError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsDeleteBatchResultBase.error" } }, { "id": 4944, "name": "failed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } }, { "id": 4945, "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": "sqs:delete-batch" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteBatchResultBase.kind" } }, { "id": 4941, "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": "SqsDeleteBatchResultBase.ok" } }, { "id": 4940, "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": "SqsDeleteBatchResultBase.processed" } }, { "id": 4943, "name": "successful", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteBatchResultBase" }, "name": "SqsDeleteBatchResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4923, "name": "SqsDeleteBatchResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful batch delete result.\n\nNote: " }, { "kind": "code", "text": "`ok: true`" }, { "kind": "text", "text": " even if some messages failed (partial failure).\nCheck " }, { "kind": "code", "text": "`failed.length > 0`" }, { "kind": "text", "text": " to detect partial failures." } ] }, "children": [ { "id": 4930, "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": "SqsDeleteBatchResultBase.duration" } }, { "id": 4926, "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": "SqsDeleteBatchResultBase.error" } }, { "id": 4928, "name": "failed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of messages that failed to delete (may be non-empty even with ok: true)." } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 4598, "name": "SqsBatchFailedEntry", "package": "@probitas-test/client-sqs" } } } }, { "id": 4929, "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": "sqs:delete-batch" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteBatchResultBase.kind" } }, { "id": 4925, "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": "SqsDeleteBatchResultBase.ok" } }, { "id": 4924, "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": "SqsDeleteBatchResultBase.processed" } }, { "id": 4927, "name": "successful", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of message IDs that were successfully deleted." } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteBatchResultBase" }, "name": "SqsDeleteBatchResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4609, "name": "SqsDeleteOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for deleting a message." } ] }, "children": [ { "id": 4613, "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": 4539, "name": "SqsOptions.retry" } }, { "id": 4612, "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": 4538, "name": "SqsOptions.signal" } }, { "id": 4610, "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": 4536, "name": "SqsOptions.throwOnError" } }, { "id": 4611, "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": 4537, "name": "SqsOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 4619, "name": "SqsDeleteQueueOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for deleting a queue." } ] }, "children": [ { "id": 4623, "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": 4539, "name": "SqsOptions.retry" } }, { "id": 4622, "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": 4538, "name": "SqsOptions.signal" } }, { "id": 4620, "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": 4536, "name": "SqsOptions.throwOnError" } }, { "id": 4621, "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": 4537, "name": "SqsOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 5056, "name": "SqsDeleteQueueResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete queue result with SQS error." } ] }, "children": [ { "id": 5061, "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": "SqsDeleteQueueResultBase.duration" } }, { "id": 5059, "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": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsDeleteQueueResultBase.error" } }, { "id": 5060, "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": "sqs:delete-queue" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteQueueResultBase.kind" } }, { "id": 5058, "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": "SqsDeleteQueueResultBase.ok" } }, { "id": 5057, "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": "SqsDeleteQueueResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteQueueResultBase" }, "name": "SqsDeleteQueueResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 5062, "name": "SqsDeleteQueueResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete queue result with connection failure." } ] }, "children": [ { "id": 5067, "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": "SqsDeleteQueueResultBase.duration" } }, { "id": 5065, "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": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsFailureError" }, "name": "SqsFailureError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsDeleteQueueResultBase.error" } }, { "id": 5066, "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": "sqs:delete-queue" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteQueueResultBase.kind" } }, { "id": 5064, "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": "SqsDeleteQueueResultBase.ok" } }, { "id": 5063, "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": "SqsDeleteQueueResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteQueueResultBase" }, "name": "SqsDeleteQueueResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 5050, "name": "SqsDeleteQueueResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful delete queue result." } ] }, "children": [ { "id": 5055, "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": "SqsDeleteQueueResultBase.duration" } }, { "id": 5053, "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": "SqsDeleteQueueResultBase.error" } }, { "id": 5054, "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": "sqs:delete-queue" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteQueueResultBase.kind" } }, { "id": 5052, "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": "SqsDeleteQueueResultBase.ok" } }, { "id": 5051, "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": "SqsDeleteQueueResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteQueueResultBase" }, "name": "SqsDeleteQueueResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4876, "name": "SqsDeleteResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete result with SQS error." } ] }, "children": [ { "id": 4881, "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": "SqsDeleteResultBase.duration" } }, { "id": 4879, "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": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsDeleteResultBase.error" } }, { "id": 4880, "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": "sqs:delete" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteResultBase.kind" } }, { "id": 4878, "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": "SqsDeleteResultBase.ok" } }, { "id": 4877, "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": "SqsDeleteResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteResultBase" }, "name": "SqsDeleteResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4882, "name": "SqsDeleteResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete result with connection failure." } ] }, "children": [ { "id": 4887, "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": "SqsDeleteResultBase.duration" } }, { "id": 4885, "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": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsFailureError" }, "name": "SqsFailureError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsDeleteResultBase.error" } }, { "id": 4886, "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": "sqs:delete" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteResultBase.kind" } }, { "id": 4884, "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": "SqsDeleteResultBase.ok" } }, { "id": 4883, "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": "SqsDeleteResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteResultBase" }, "name": "SqsDeleteResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4870, "name": "SqsDeleteResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful delete result." } ] }, "children": [ { "id": 4875, "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": "SqsDeleteResultBase.duration" } }, { "id": 4873, "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": "SqsDeleteResultBase.error" } }, { "id": 4874, "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": "sqs:delete" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsDeleteResultBase.kind" } }, { "id": 4872, "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": "SqsDeleteResultBase.ok" } }, { "id": 4871, "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": "SqsDeleteResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsDeleteResultBase" }, "name": "SqsDeleteResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4602, "name": "SqsEnsureQueueOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for ensuring a queue exists." } ] }, "children": [ { "id": 4603, "name": "attributes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Queue attributes (e.g., DelaySeconds, MessageRetentionPeriod)" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "name": "Record", "package": "typescript" } }, { "id": 4608, "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": 4539, "name": "SqsOptions.retry" } }, { "id": 4607, "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": 4538, "name": "SqsOptions.signal" } }, { "id": 4604, "name": "tags", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Queue tags" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "name": "Record", "package": "typescript" } }, { "id": 4605, "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": 4536, "name": "SqsOptions.throwOnError" } }, { "id": 4606, "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": 4537, "name": "SqsOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 4997, "name": "SqsEnsureQueueResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Ensure queue result with SQS error." } ] }, "children": [ { "id": 5003, "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": "SqsEnsureQueueResultBase.duration" } }, { "id": 5000, "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": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsEnsureQueueResultBase.error" } }, { "id": 5002, "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": "sqs:ensure-queue" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsEnsureQueueResultBase.kind" } }, { "id": 4999, "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": "SqsEnsureQueueResultBase.ok" } }, { "id": 4998, "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": "SqsEnsureQueueResultBase.processed" } }, { "id": 5001, "name": "queueUrl", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsEnsureQueueResultBase" }, "name": "SqsEnsureQueueResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 5004, "name": "SqsEnsureQueueResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Ensure queue result with connection failure." } ] }, "children": [ { "id": 5010, "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": "SqsEnsureQueueResultBase.duration" } }, { "id": 5007, "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": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsFailureError" }, "name": "SqsFailureError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsEnsureQueueResultBase.error" } }, { "id": 5009, "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": "sqs:ensure-queue" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsEnsureQueueResultBase.kind" } }, { "id": 5006, "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": "SqsEnsureQueueResultBase.ok" } }, { "id": 5005, "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": "SqsEnsureQueueResultBase.processed" } }, { "id": 5008, "name": "queueUrl", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsEnsureQueueResultBase" }, "name": "SqsEnsureQueueResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4990, "name": "SqsEnsureQueueResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful ensure queue result." } ] }, "children": [ { "id": 4996, "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": "SqsEnsureQueueResultBase.duration" } }, { "id": 4993, "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": "SqsEnsureQueueResultBase.error" } }, { "id": 4995, "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": "sqs:ensure-queue" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsEnsureQueueResultBase.kind" } }, { "id": 4992, "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": "SqsEnsureQueueResultBase.ok" } }, { "id": 4991, "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": "SqsEnsureQueueResultBase.processed" } }, { "id": 4994, "name": "queueUrl", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "URL of the queue (existing or newly created)." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsEnsureQueueResultBase" }, "name": "SqsEnsureQueueResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 5128, "name": "SqsError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for SQS client errors." } ] }, "children": [ { "id": 5130, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 5131, "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": 5129, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"SqsError\"", "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": 5114, "name": "SqsBatchError" }, { "type": "reference", "target": 5119, "name": "SqsCommandError" }, { "type": "reference", "target": 5124, "name": "SqsConnectionError" }, { "type": "reference", "target": 5132, "name": "SqsMessageNotFoundError" }, { "type": "reference", "target": 5136, "name": "SqsMessageTooLargeError" }, { "type": "reference", "target": 5142, "name": "SqsQueueNotFoundError" } ] }, { "id": 4662, "name": "SqsErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for SQS errors." } ] }, "children": [ { "id": 4663, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2022.error.d.ts", "qualifiedName": "ErrorOptions" }, "name": "ErrorOptions", "package": "typescript" } ], "extendedBy": [ { "type": "reference", "target": 4664, "name": "SqsCommandErrorOptions" } ] }, { "id": 4564, "name": "SqsMessage", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQS message received from a queue." } ] }, "children": [ { "id": 4568, "name": "attributes", "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": "string" } ], "name": "Record", "package": "typescript" } }, { "id": 4566, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4570, "name": "md5OfBody", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4569, "name": "messageAttributes", "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": "reference", "target": 4560, "name": "SqsMessageAttribute", "package": "@probitas-test/client-sqs" } ], "name": "Record", "package": "typescript" } }, { "id": 4565, "name": "messageId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4567, "name": "receiptHandle", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 4560, "name": "SqsMessageAttribute", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQS message attributes." } ] }, "children": [ { "id": 4563, "name": "binaryValue", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "Uint8Array", "package": "typescript" } }, { "id": 4561, "name": "dataType", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": "String" }, { "type": "literal", "value": "Number" }, { "type": "literal", "value": "Binary" } ] } }, { "id": 4562, "name": "stringValue", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 5132, "name": "SqsMessageNotFoundError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a message is not found or receipt handle is invalid." } ] }, "children": [ { "id": 5135, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 5130, "name": "SqsError.code" } }, { "id": 5134, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "message_not_found" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 5131, "name": "SqsError.kind" } }, { "id": 5133, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqsMessageNotFoundError" }, "defaultValue": "\"SqsMessageNotFoundError\"", "overwrites": { "type": "reference", "target": 5129, "name": "SqsError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" } ] }, { "id": 5136, "name": "SqsMessageTooLargeError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a message exceeds the size limit." } ] }, "children": [ { "id": 5141, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 5130, "name": "SqsError.code" } }, { "id": 5138, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "message_too_large" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 5131, "name": "SqsError.kind" } }, { "id": 5140, "name": "maxSize", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 5137, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqsMessageTooLargeError" }, "defaultValue": "\"SqsMessageTooLargeError\"", "overwrites": { "type": "reference", "target": 5129, "name": "SqsError.name" } }, { "id": 5139, "name": "size", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" } } ], "extendedTypes": [ { "type": "reference", "target": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" } ] }, { "id": 4535, "name": "SqsOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Common options with throwOnError support." } ] }, "children": [ { "id": 4539, "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": 4538, "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": 4536, "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": 4537, "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": 4548, "name": "SqsClientConfig" }, { "type": "reference", "target": 4571, "name": "SqsSendOptions" }, { "type": "reference", "target": 4585, "name": "SqsReceiveOptions" }, { "type": "reference", "target": 4602, "name": "SqsEnsureQueueOptions" }, { "type": "reference", "target": 4609, "name": "SqsDeleteOptions" }, { "type": "reference", "target": 4614, "name": "SqsBatchOptions" }, { "type": "reference", "target": 4619, "name": "SqsDeleteQueueOptions" } ] }, { "id": 5142, "name": "SqsQueueNotFoundError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a queue is not found." } ] }, "children": [ { "id": 5146, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 5130, "name": "SqsError.code" } }, { "id": 5144, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "queue_not_found" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 5131, "name": "SqsError.kind" } }, { "id": 5143, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "SqsQueueNotFoundError" }, "defaultValue": "\"SqsQueueNotFoundError\"", "overwrites": { "type": "reference", "target": 5129, "name": "SqsError.name" } }, { "id": 5145, "name": "queueUrl", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" } ] }, { "id": 4585, "name": "SqsReceiveOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for receiving messages." } ] }, "children": [ { "id": 4589, "name": "attributeNames", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "System attribute names to retrieve" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } }, { "id": 4586, "name": "maxMessages", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of messages to receive (1-10, default: 1)" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4590, "name": "messageAttributeNames", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Message attribute names to retrieve" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } }, { "id": 4594, "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": 4539, "name": "SqsOptions.retry" } }, { "id": 4593, "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": 4538, "name": "SqsOptions.signal" } }, { "id": 4591, "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": 4536, "name": "SqsOptions.throwOnError" } }, { "id": 4592, "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": 4537, "name": "SqsOptions.timeout" } }, { "id": 4588, "name": "visibilityTimeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Visibility timeout in seconds (0-43200)" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4587, "name": "waitTimeSeconds", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Wait time in seconds for long polling (0-20)" } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "extendedTypes": [ { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 4817, "name": "SqsReceiveResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Receive result with SQS error." } ] }, "children": [ { "id": 4823, "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": "SqsReceiveResultBase.duration" } }, { "id": 4820, "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": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsReceiveResultBase.error" } }, { "id": 4822, "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": "sqs:receive" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsReceiveResultBase.kind" } }, { "id": 4821, "name": "messages", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "tuple" } } }, { "id": 4819, "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": "SqsReceiveResultBase.ok" } }, { "id": 4818, "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": "SqsReceiveResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsReceiveResultBase" }, "name": "SqsReceiveResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4824, "name": "SqsReceiveResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Receive result with connection failure." } ] }, "children": [ { "id": 4830, "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": "SqsReceiveResultBase.duration" } }, { "id": 4827, "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": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsFailureError" }, "name": "SqsFailureError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsReceiveResultBase.error" } }, { "id": 4829, "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": "sqs:receive" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsReceiveResultBase.kind" } }, { "id": 4828, "name": "messages", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } }, { "id": 4826, "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": "SqsReceiveResultBase.ok" } }, { "id": 4825, "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": "SqsReceiveResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsReceiveResultBase" }, "name": "SqsReceiveResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4810, "name": "SqsReceiveResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful receive result." } ] }, "children": [ { "id": 4816, "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": "SqsReceiveResultBase.duration" } }, { "id": 4813, "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": "SqsReceiveResultBase.error" } }, { "id": 4815, "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": "sqs:receive" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsReceiveResultBase.kind" } }, { "id": 4814, "name": "messages", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of received messages (may be empty)." } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 4564, "name": "SqsMessage", "package": "@probitas-test/client-sqs" } } } }, { "id": 4812, "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": "SqsReceiveResultBase.ok" } }, { "id": 4811, "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": "SqsReceiveResultBase.processed" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsReceiveResultBase" }, "name": "SqsReceiveResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4751, "name": "SqsSendBatchResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Batch send result with SQS error." } ] }, "children": [ { "id": 4758, "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": "SqsSendBatchResultBase.duration" } }, { "id": 4754, "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": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsSendBatchResultBase.error" } }, { "id": 4756, "name": "failed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "tuple" } } }, { "id": 4757, "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": "sqs:send-batch" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsSendBatchResultBase.kind" } }, { "id": 4753, "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": "SqsSendBatchResultBase.ok" } }, { "id": 4752, "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": "SqsSendBatchResultBase.processed" } }, { "id": 4755, "name": "successful", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "tuple" } } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsSendBatchResultBase" }, "name": "SqsSendBatchResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4759, "name": "SqsSendBatchResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Batch send result with connection failure." } ] }, "children": [ { "id": 4766, "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": "SqsSendBatchResultBase.duration" } }, { "id": 4762, "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": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsFailureError" }, "name": "SqsFailureError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsSendBatchResultBase.error" } }, { "id": 4764, "name": "failed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } }, { "id": 4765, "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": "sqs:send-batch" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsSendBatchResultBase.kind" } }, { "id": 4761, "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": "SqsSendBatchResultBase.ok" } }, { "id": 4760, "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": "SqsSendBatchResultBase.processed" } }, { "id": 4763, "name": "successful", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsSendBatchResultBase" }, "name": "SqsSendBatchResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4743, "name": "SqsSendBatchResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful batch send result.\n\nNote: " }, { "kind": "code", "text": "`ok: true`" }, { "kind": "text", "text": " even if some messages failed (partial failure).\nCheck " }, { "kind": "code", "text": "`failed.length > 0`" }, { "kind": "text", "text": " to detect partial failures." } ] }, "children": [ { "id": 4750, "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": "SqsSendBatchResultBase.duration" } }, { "id": 4746, "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": "SqsSendBatchResultBase.error" } }, { "id": 4748, "name": "failed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of messages that failed to send (may be non-empty even with ok: true)." } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 4598, "name": "SqsBatchFailedEntry", "package": "@probitas-test/client-sqs" } } } }, { "id": 4749, "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": "sqs:send-batch" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsSendBatchResultBase.kind" } }, { "id": 4745, "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": "SqsSendBatchResultBase.ok" } }, { "id": 4744, "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": "SqsSendBatchResultBase.processed" } }, { "id": 4747, "name": "successful", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of successfully sent messages." } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 4595, "name": "SqsBatchSuccessEntry", "package": "@probitas-test/client-sqs" } } } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsSendBatchResultBase" }, "name": "SqsSendBatchResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4571, "name": "SqsSendOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for sending a message." } ] }, "children": [ { "id": 4572, "name": "delaySeconds", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Delay in seconds before the message becomes visible (0-900)" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 4573, "name": "messageAttributes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Message attributes" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 4560, "name": "SqsMessageAttribute", "package": "@probitas-test/client-sqs" } ], "name": "Record", "package": "typescript" } }, { "id": 4575, "name": "messageDeduplicationId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Message deduplication ID (required for FIFO queues without content-based deduplication)" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4574, "name": "messageGroupId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Message group ID (required for FIFO queues)" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4579, "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": 4539, "name": "SqsOptions.retry" } }, { "id": 4578, "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": 4538, "name": "SqsOptions.signal" } }, { "id": 4576, "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": 4536, "name": "SqsOptions.throwOnError" } }, { "id": 4577, "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": 4537, "name": "SqsOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": 4535, "name": "SqsOptions", "package": "@probitas-test/client-sqs" } ] }, { "id": 4678, "name": "SqsSendResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Send result with SQS error." } ] }, "children": [ { "id": 4686, "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": "SqsSendResultBase.duration" } }, { "id": 4681, "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": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsSendResultBase.error" } }, { "id": 4685, "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": "sqs:send" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsSendResultBase.kind" } }, { "id": 4683, "name": "md5OfBody", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } }, { "id": 4682, "name": "messageId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } }, { "id": 4680, "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": "SqsSendResultBase.ok" } }, { "id": 4679, "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": "SqsSendResultBase.processed" } }, { "id": 4684, "name": "sequenceNumber", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsSendResultBase" }, "name": "SqsSendResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4687, "name": "SqsSendResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Send result with connection failure." } ] }, "children": [ { "id": 4695, "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": "SqsSendResultBase.duration" } }, { "id": 4690, "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": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsFailureError" }, "name": "SqsFailureError", "package": "@probitas-test/client-sqs" }, "overwrites": { "type": "reference", "target": -1, "name": "SqsSendResultBase.error" } }, { "id": 4694, "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": "sqs:send" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsSendResultBase.kind" } }, { "id": 4692, "name": "md5OfBody", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } }, { "id": 4691, "name": "messageId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } }, { "id": 4689, "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": "SqsSendResultBase.ok" } }, { "id": 4688, "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": "SqsSendResultBase.processed" } }, { "id": 4693, "name": "sequenceNumber", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsSendResultBase" }, "name": "SqsSendResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 4669, "name": "SqsSendResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful send result." } ] }, "children": [ { "id": 4677, "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": "SqsSendResultBase.duration" } }, { "id": 4672, "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": "SqsSendResultBase.error" } }, { "id": 4676, "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": "sqs:send" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "SqsSendResultBase.kind" } }, { "id": 4674, "name": "md5OfBody", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "MD5 hash of the message body (for integrity verification)." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4673, "name": "messageId", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the sent message." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 4671, "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": "SqsSendResultBase.ok" } }, { "id": 4670, "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": "SqsSendResultBase.processed" } }, { "id": 4675, "name": "sequenceNumber", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Sequence number for FIFO queues (present only for FIFO queues)." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-sqs", "packagePath": "result.ts", "qualifiedName": "SqsSendResultBase" }, "name": "SqsSendResultBase", "package": "@probitas-test/client-sqs" } ] }, { "id": 5106, "name": "SqsDeleteBatchResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result of batch deleting messages." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 4923, "name": "SqsDeleteBatchResultSuccess", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4931, "name": "SqsDeleteBatchResultError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4939, "name": "SqsDeleteBatchResultFailure", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5107, "name": "SqsDeleteQueueResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result of deleting a queue." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 5050, "name": "SqsDeleteQueueResultSuccess", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5056, "name": "SqsDeleteQueueResultError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5062, "name": "SqsDeleteQueueResultFailure", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5108, "name": "SqsDeleteResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result of deleting a message." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 4870, "name": "SqsDeleteResultSuccess", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4876, "name": "SqsDeleteResultError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4882, "name": "SqsDeleteResultFailure", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5109, "name": "SqsEnsureQueueResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result of ensuring a queue exists." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 4990, "name": "SqsEnsureQueueResultSuccess", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4997, "name": "SqsEnsureQueueResultError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5004, "name": "SqsEnsureQueueResultFailure", "package": "@probitas-test/client-sqs" } ] } }, { "id": 4668, "name": "SqsFailureError", "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 SQS service." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 5124, "name": "SqsConnectionError", "package": "@probitas-test/client-sqs" }, { "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": 4667, "name": "SqsOperationError", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error types that indicate an operation was processed by the server.\nThese errors occur after the operation reaches the SQS service." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 5119, "name": "SqsCommandError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5142, "name": "SqsQueueNotFoundError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5136, "name": "SqsMessageTooLargeError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5114, "name": "SqsBatchError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5132, "name": "SqsMessageNotFoundError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5128, "name": "SqsError", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5110, "name": "SqsReceiveResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result of receiving messages." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 4810, "name": "SqsReceiveResultSuccess", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4817, "name": "SqsReceiveResultError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4824, "name": "SqsReceiveResultFailure", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5111, "name": "SqsResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Union type of all SQS result types." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 5113, "name": "SqsSendResult", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5112, "name": "SqsSendBatchResult", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5110, "name": "SqsReceiveResult", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5108, "name": "SqsDeleteResult", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5106, "name": "SqsDeleteBatchResult", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5109, "name": "SqsEnsureQueueResult", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 5107, "name": "SqsDeleteQueueResult", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5112, "name": "SqsSendBatchResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result of batch sending messages." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 4743, "name": "SqsSendBatchResultSuccess", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4751, "name": "SqsSendBatchResultError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4759, "name": "SqsSendBatchResultFailure", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5113, "name": "SqsSendResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result of sending a message." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 4669, "name": "SqsSendResultSuccess", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4678, "name": "SqsSendResultError", "package": "@probitas-test/client-sqs" }, { "type": "reference", "target": 4687, "name": "SqsSendResultFailure", "package": "@probitas-test/client-sqs" } ] } }, { "id": 5103, "name": "createSqsClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 5104, "name": "createSqsClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new Amazon SQS client instance.\n\nThe client provides queue management, message publishing and consumption,\nbatch operations, and supports both standard and FIFO queues via AWS SDK." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise resolving to a new SQS client instance" } ] }, { "tag": "@example", "name": "Basic usage with existing queue", "content": [ { "kind": "code", "text": "```ts\nimport { createSqsClient } from \"@probitas-test/client-sqs\";\n\nasync function example() {\n const sqs = await createSqsClient({\n region: \"ap-northeast-1\",\n queueUrl: \"https://sqs.ap-northeast-1.amazonaws.com/123456789/my-queue\",\n credentials: { accessKeyId: \"test\", secretAccessKey: \"test\" },\n });\n\n // Send a message\n const sendResult = await sqs.send(JSON.stringify({\n type: \"ORDER\",\n orderId: \"123\",\n }));\n\n if (sendResult.ok) {\n console.log(\"Message ID:\", sendResult.messageId);\n } else {\n console.error(\"Error:\", sendResult.error.message);\n }\n\n await sqs.close();\n}\n```" } ] }, { "tag": "@example", "name": "Using ElasticMQ for local development", "content": [ { "kind": "code", "text": "```ts\nimport { createSqsClient } from \"@probitas-test/client-sqs\";\n\nasync function example() {\n const sqs = await createSqsClient({\n region: \"us-east-1\",\n url: \"http://localhost:9324\",\n credentials: {\n accessKeyId: \"test\",\n secretAccessKey: \"test\",\n },\n });\n\n // Create queue dynamically (also sets queueUrl)\n const result = await sqs.ensureQueue(\"test-queue\");\n if (result.ok) {\n console.log(result.queueUrl); // http://localhost:9324/000000000000/test-queue\n }\n\n await sqs.close();\n}\n```" } ] }, { "tag": "@example", "name": "Receiving messages with long polling", "content": [ { "kind": "code", "text": "```ts\nimport { createSqsClient } from \"@probitas-test/client-sqs\";\n\nasync function example() {\n const sqs = await createSqsClient({\n region: \"us-east-1\",\n url: \"http://localhost:9324\",\n credentials: { accessKeyId: \"test\", secretAccessKey: \"test\" },\n });\n await sqs.ensureQueue(\"test-queue\");\n\n // Long polling waits up to 20 seconds for messages\n const receiveResult = await sqs.receive({\n maxMessages: 10,\n waitTimeSeconds: 20,\n visibilityTimeout: 30,\n });\n\n if (receiveResult.ok) {\n console.log(\"Received:\", receiveResult.messages.length);\n\n // Process and acknowledge messages\n for (const msg of receiveResult.messages) {\n const data = JSON.parse(msg.body);\n console.log(\"Processing:\", data);\n\n // Delete after successful processing\n await sqs.delete(msg.receiptHandle);\n }\n }\n\n await sqs.close();\n}\n```" } ] }, { "tag": "@example", "name": "Batch operations for high throughput", "content": [ { "kind": "code", "text": "```ts\nimport { createSqsClient } from \"@probitas-test/client-sqs\";\n\nasync function example() {\n const sqs = await createSqsClient({\n region: \"us-east-1\",\n url: \"http://localhost:9324\",\n credentials: { accessKeyId: \"test\", secretAccessKey: \"test\" },\n });\n await sqs.ensureQueue(\"test-queue\");\n\n // Send multiple messages in a single API call\n const batchResult = await sqs.sendBatch([\n { id: \"1\", body: JSON.stringify({ event: \"user.created\", userId: \"a1\" }) },\n { id: \"2\", body: JSON.stringify({ event: \"user.created\", userId: \"a2\" }) },\n { id: \"3\", body: JSON.stringify({ event: \"user.updated\", userId: \"a3\" }) },\n ]);\n\n if (batchResult.ok) {\n console.log(`Sent: ${batchResult.successful.length}`);\n console.log(`Failed: ${batchResult.failed.length}`);\n }\n\n // Batch delete processed messages\n const receiveResult = await sqs.receive({ maxMessages: 10 });\n if (receiveResult.ok) {\n const handles = receiveResult.messages.map((m) => m.receiptHandle);\n await sqs.deleteBatch(handles);\n }\n\n await sqs.close();\n}\n```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createSqsClient } from \"@probitas-test/client-sqs\";\n\nasync function example() {\n await using sqs = await createSqsClient({\n region: \"us-east-1\",\n url: \"http://localhost:9324\",\n credentials: { accessKeyId: \"test\", secretAccessKey: \"test\" },\n });\n\n await sqs.ensureQueue(\"test-queue\");\n await sqs.send(\"Hello, SQS!\");\n // Client automatically closed when scope exits\n}\n```" } ] } ] }, "parameters": [ { "id": 5105, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SQS client configuration" } ] }, "type": { "type": "reference", "target": 4548, "name": "SqsClientConfig", "package": "@probitas-test/client-sqs" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 4624, "name": "SqsClient", "package": "@probitas-test/client-sqs" } ], "name": "Promise", "package": "typescript" } } ] } ], "packageName": "@probitas-test/client-sqs", "packageVersion": "0.6.1" }