{ "schemaVersion": "2.0", "id": 2158, "name": "@probitas-test/client-redis", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a Redis client designed for integration testing of applications using Redis.\n\n## Features\n\n- **Data Structures**: Strings, Hashes, Lists, Sets, Sorted Sets\n- **Pub/Sub**: Publish and subscribe to channels\n- **Transactions**: Atomic operations with MULTI/EXEC\n- **Raw Commands**: Execute any Redis command via " }, { "kind": "code", "text": "`command()`" }, { "kind": "text", "text": "\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-redis\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({\n url: \"redis://localhost:6379/0\",\n});\n\n// String operations\nawait client.set(\"user:1:name\", \"Alice\", { ex: 3600 });\nconst result = await client.get(\"user:1:name\");\nconsole.log(\"Name:\", result.value);\n\n// Hash operations\nawait client.hset(\"user:1\", \"email\", \"alice@example.com\");\nconst email = await client.hget(\"user:1\", \"email\");\nconsole.log(\"Email:\", email.value);\n\n// List operations\nawait client.rpush(\"queue\", [\"job1\", \"job2\", \"job3\"]);\nconst job = await client.lpop(\"queue\");\nconsole.log(\"Job:\", job.value);\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Transactions\n\n" }, { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({ url: \"redis://localhost:6379\" });\n\n// Atomic transaction\nconst tx = client.multi();\ntx.incr(\"counter\");\ntx.get(\"counter\");\nawait tx.exec();\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Pub/Sub\n\n" }, { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({ url: \"redis://localhost:6379\" });\n\n// Subscribe to a channel\nconst subscription = client.subscribe(\"events\");\nfor await (const message of subscription) {\n console.log(\"Received:\", message.message);\n break;\n}\n\n// Publish to a channel\nawait client.publish(\"events\", JSON.stringify({ type: \"update\" }));\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Connection Configuration\n\n" }, { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\n// Using URL string\nconst client1 = await createRedisClient({ url: \"redis://localhost:6379\" });\n\n// Using URL with password and database\nconst client2 = await createRedisClient({ url: \"redis://:secret@localhost:6379/1\" });\n\n// Using config object\nconst client3 = await createRedisClient({\n url: { host: \"localhost\", port: 6379, password: \"secret\", db: 1 },\n});\n\nawait client1.close();\nawait client2.close();\nawait client3.close();\n```" }, { "kind": "text", "text": "\n\n## Using with " }, { "kind": "code", "text": "`using`" }, { "kind": "text", "text": " Statement\n\n" }, { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nawait using client = await createRedisClient({ url: \"redis://localhost:6379\" });\n\nawait client.set(\"test\", \"value\");\nconst result = await client.get(\"test\");\nconsole.log(result.value);\n// Client automatically closed when block exits\n```" }, { "kind": "text", "text": "\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [" }, { "kind": "code", "text": "`@probitas-test/client`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client) | Core utilities and types |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [Redis](https://redis.io/)" } ] }, "children": [ { "id": 2780, "name": "RedisCommandError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a Redis command fails." } ] }, "children": [ { "id": 2781, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 2782, "name": "RedisCommandError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 2783, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2784, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 2777, "name": "RedisCommandErrorOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": 2780, "name": "RedisCommandError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": 2762, "name": "RedisError.constructor" } } ], "overwrites": { "type": "reference", "target": 2761, "name": "RedisError.constructor" } }, { "id": 2788, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 2767, "name": "RedisError.code" } }, { "id": 2787, "name": "command", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2786, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "command" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 2768, "name": "RedisError.kind" } }, { "id": 2785, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "RedisCommandError" }, "defaultValue": "\"RedisCommandError\"", "overwrites": { "type": "reference", "target": 2766, "name": "RedisError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 2760, "name": "RedisError", "package": "@probitas-test/client-redis" } ] }, { "id": 2769, "name": "RedisConnectionError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a Redis connection cannot be established." } ] }, "children": [ { "id": 2770, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 2771, "name": "RedisConnectionError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 2772, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2773, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2758, "name": "RedisErrorOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": 2769, "name": "RedisConnectionError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": 2762, "name": "RedisError.constructor" } } ], "overwrites": { "type": "reference", "target": 2761, "name": "RedisError.constructor" } }, { "id": 2776, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 2767, "name": "RedisError.code" } }, { "id": 2775, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connection" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 2768, "name": "RedisError.kind" } }, { "id": 2774, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "RedisConnectionError" }, "defaultValue": "\"RedisConnectionError\"", "overwrites": { "type": "reference", "target": 2766, "name": "RedisError.name" } } ], "extendedTypes": [ { "type": "reference", "target": 2760, "name": "RedisError", "package": "@probitas-test/client-redis" } ] }, { "id": 2760, "name": "RedisError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for Redis client errors." } ] }, "children": [ { "id": 2761, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 2762, "name": "RedisError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 2763, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2764, "name": "kind", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"redis\"" }, { "id": 2765, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2758, "name": "RedisErrorOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": 2760, "name": "RedisError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } } ], "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } }, { "id": 2767, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2768, "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": 2766, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"RedisError\"", "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": 2769, "name": "RedisConnectionError" }, { "type": "reference", "target": 2780, "name": "RedisCommandError" }, { "type": "reference", "target": 2792, "name": "RedisScriptError" } ] }, { "id": 2792, "name": "RedisScriptError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a Redis Lua script fails." } ] }, "children": [ { "id": 2793, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 2794, "name": "RedisScriptError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 2795, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2796, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 2789, "name": "RedisScriptErrorOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": 2792, "name": "RedisScriptError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": 2762, "name": "RedisError.constructor" } } ], "overwrites": { "type": "reference", "target": 2761, "name": "RedisError.constructor" } }, { "id": 2800, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 2767, "name": "RedisError.code" } }, { "id": 2798, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "script" }, "defaultValue": "...", "overwrites": { "type": "reference", "target": 2768, "name": "RedisError.kind" } }, { "id": 2797, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "RedisScriptError" }, "defaultValue": "\"RedisScriptError\"", "overwrites": { "type": "reference", "target": 2766, "name": "RedisError.name" } }, { "id": 2799, "name": "script", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": 2760, "name": "RedisError", "package": "@probitas-test/client-redis" } ] }, { "id": 2481, "name": "RedisArrayResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array result with Redis error." } ] }, "children": [ { "id": 2488, "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": "RedisArrayResultBase.duration" } }, { "id": 2485, "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": 2805, "name": "RedisOperationError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisArrayResultBase.error" } }, { "id": 2487, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:array" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisArrayResultBase.kind" } }, { "id": 2484, "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": "RedisArrayResultBase.ok" } }, { "id": 2483, "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": "RedisArrayResultBase.processed" } }, { "id": 2486, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisArrayResultBase.value", "package": "@probitas-test/client-redis" } } ], "typeParameters": [ { "id": 2482, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisArrayResultBase" }, "typeArguments": [ { "type": "reference", "target": 2482, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisArrayResultError.T", "refersToTypeParameter": true } ], "name": "RedisArrayResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2489, "name": "RedisArrayResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array result with connection failure." } ] }, "children": [ { "id": 2496, "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": "RedisArrayResultBase.duration" } }, { "id": 2493, "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": 2804, "name": "RedisFailureError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisArrayResultBase.error" } }, { "id": 2495, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:array" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisArrayResultBase.kind" } }, { "id": 2492, "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": "RedisArrayResultBase.ok" } }, { "id": 2491, "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": "RedisArrayResultBase.processed" } }, { "id": 2494, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisArrayResultBase.value", "package": "@probitas-test/client-redis" } } ], "typeParameters": [ { "id": 2490, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisArrayResultBase" }, "typeArguments": [ { "type": "reference", "target": 2490, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisArrayResultFailure.T", "refersToTypeParameter": true } ], "name": "RedisArrayResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2473, "name": "RedisArrayResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful array result." } ] }, "children": [ { "id": 2480, "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": "RedisArrayResultBase.duration" } }, { "id": 2477, "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": "RedisArrayResultBase.error" } }, { "id": 2479, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:array" }, "inheritedFrom": { "type": "reference", "target": 2487, "name": "RedisArrayResultBase.kind", "package": "@probitas-test/client-redis" } }, { "id": 2476, "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": "RedisArrayResultBase.ok" } }, { "id": 2475, "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": "RedisArrayResultBase.processed" } }, { "id": 2478, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 2474, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisArrayResultSuccess.T", "refersToTypeParameter": true } } }, "overwrites": { "type": "reference", "target": -1, "name": "RedisArrayResultBase.value", "package": "@probitas-test/client-redis" } } ], "typeParameters": [ { "id": 2474, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisArrayResultBase" }, "typeArguments": [ { "type": "reference", "target": 2474, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisArrayResultSuccess.T", "refersToTypeParameter": true } ], "name": "RedisArrayResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2280, "name": "RedisClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis client interface" } ] }, "children": [ { "id": 2281, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 2182, "name": "RedisClientConfig", "package": "@probitas-test/client-redis" } }, { "id": 2405, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2406, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2399, "name": "command", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2400, "name": "command", "variant": "signature", "kind": 4096, "flags": {}, "typeParameters": [ { "id": 2401, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "parameters": [ { "id": 2402, "name": "cmd", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2403, "name": "args", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } }, { "id": 2404, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2545, "typeArguments": [ { "type": "reference", "target": 2401, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisCommonResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2299, "name": "decr", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2300, "name": "decr", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2301, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2302, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2291, "name": "del", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2292, "name": "del", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2293, "name": "keys", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 2294, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2282, "name": "get", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2283, "name": "get", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2284, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2285, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2428, "name": "RedisGetResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2318, "name": "hdel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2319, "name": "hdel", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2320, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2321, "name": "fields", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 2322, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2303, "name": "hget", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2304, "name": "hget", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2305, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2306, "name": "field", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2307, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2428, "name": "RedisGetResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2314, "name": "hgetall", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2315, "name": "hgetall", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2316, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2317, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2520, "name": "RedisHashResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2308, "name": "hset", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2309, "name": "hset", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2310, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2311, "name": "field", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2312, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2313, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2295, "name": "incr", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2296, "name": "incr", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2297, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2298, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2347, "name": "llen", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2348, "name": "llen", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2349, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2350, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2333, "name": "lpop", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2334, "name": "lpop", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2335, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2336, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2428, "name": "RedisGetResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2323, "name": "lpush", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2324, "name": "lpush", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2325, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2326, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 2327, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2341, "name": "lrange", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2342, "name": "lrange", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2343, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2344, "name": "start", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2345, "name": "stop", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2346, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2497, "name": "RedisArrayResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2397, "name": "multi", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2398, "name": "multi", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", "target": 2188, "name": "RedisTransaction", "package": "@probitas-test/client-redis" } } ] }, { "id": 2389, "name": "publish", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2390, "name": "publish", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2391, "name": "channel", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2392, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2393, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2337, "name": "rpop", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2338, "name": "rpop", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2339, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2340, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2428, "name": "RedisGetResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2328, "name": "rpush", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2329, "name": "rpush", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2330, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2331, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 2332, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2351, "name": "sadd", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2352, "name": "sadd", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2353, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2354, "name": "members", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 2355, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2286, "name": "set", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2287, "name": "set", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2288, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2289, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2290, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2164, "name": "RedisSetOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2450, "name": "RedisSetResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2365, "name": "sismember", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2366, "name": "sismember", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2367, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2368, "name": "member", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2369, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2545, "typeArguments": [ { "type": "intrinsic", "name": "boolean" } ], "name": "RedisCommonResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2361, "name": "smembers", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2362, "name": "smembers", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2363, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2364, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2497, "name": "RedisArrayResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2356, "name": "srem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2357, "name": "srem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2358, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2359, "name": "members", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 2360, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2394, "name": "subscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2395, "name": "subscribe", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2396, "name": "channel", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "reference", "target": 2173, "name": "RedisMessage", "package": "@probitas-test/client-redis" } ], "name": "AsyncIterable", "package": "typescript" } } ] }, { "id": 2370, "name": "zadd", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2371, "name": "zadd", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2372, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2373, "name": "entries", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 2374, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 2376, "name": "member", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2375, "name": "score", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ] } } } }, { "id": 2377, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2378, "name": "zrange", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2379, "name": "zrange", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2380, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2381, "name": "start", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2382, "name": "stop", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2383, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2497, "name": "RedisArrayResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2384, "name": "zscore", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2385, "name": "zscore", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2386, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2387, "name": "member", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2388, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2545, "typeArguments": [ { "type": "union", "types": [ { "type": "intrinsic", "name": "number" }, { "type": "literal", "value": null } ] } ], "name": "RedisCommonResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 2182, "name": "RedisClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis client configuration." } ] }, "children": [ { "id": 2187, "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": 2186, "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": 2184, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw an error when operations fail.\n\nWhen " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", failures will throw an error instead of returning a result\nwith " }, { "kind": "code", "text": "`ok: false`" }, { "kind": "text", "text": ". This can be overridden per-command." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 2185, "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" } }, { "id": 2183, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Redis connection URL or configuration object." } ], "blockTags": [ { "tag": "@example", "name": "String URL", "content": [ { "kind": "code", "text": "```ts\nimport type { RedisClientConfig } from \"@probitas-test/client-redis\";\nconst config: RedisClientConfig = { url: \"redis://localhost:6379\" };\n```" } ] }, { "tag": "@example", "name": "With password", "content": [ { "kind": "code", "text": "```ts\nimport type { RedisClientConfig } from \"@probitas-test/client-redis\";\nconst config: RedisClientConfig = { url: \"redis://:password@localhost:6379/0\" };\n```" } ] }, { "tag": "@example", "name": "Config object", "content": [ { "kind": "code", "text": "```ts\nimport type { RedisClientConfig } from \"@probitas-test/client-redis\";\nconst config: RedisClientConfig = {\n url: { port: 6379, password: \"secret\", db: 1 },\n};\n```" } ] } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": 2176, "name": "RedisConnectionConfig", "package": "@probitas-test/client-redis" } ] } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 2777, "name": "RedisCommandErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for Redis command errors." } ] }, "children": [ { "id": 2779, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 2759, "name": "RedisErrorOptions.code" } }, { "id": 2778, "name": "command", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": 2758, "name": "RedisErrorOptions", "package": "@probitas-test/client-redis" } ] }, { "id": 2159, "name": "RedisCommandOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis command options.\n\nExtends CommonOptions with Redis-specific behavior options." } ] }, "children": [ { "id": 2163, "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": 2162, "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": 2160, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw an error when the operation fails.\n\nWhen " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", failures will throw an error instead of returning a result\nwith " }, { "kind": "code", "text": "`ok: false`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse (inherited from client config or defaults to false)\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 2161, "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": 2164, "name": "RedisSetOptions" } ] }, { "id": 2529, "name": "RedisCommonResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Common result with Redis error." } ] }, "children": [ { "id": 2536, "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": "RedisCommonResultBase.duration" } }, { "id": 2533, "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": 2805, "name": "RedisOperationError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCommonResultBase.error" } }, { "id": 2535, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:common" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisCommonResultBase.kind" } }, { "id": 2532, "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": "RedisCommonResultBase.ok" } }, { "id": 2531, "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": "RedisCommonResultBase.processed" } }, { "id": 2534, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCommonResultBase.value", "package": "@probitas-test/client-redis" } } ], "typeParameters": [ { "id": 2530, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisCommonResultBase" }, "typeArguments": [ { "type": "reference", "target": 2530, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisCommonResultError.T", "refersToTypeParameter": true } ], "name": "RedisCommonResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2537, "name": "RedisCommonResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Common result with connection failure." } ] }, "children": [ { "id": 2544, "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": "RedisCommonResultBase.duration" } }, { "id": 2541, "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": 2804, "name": "RedisFailureError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCommonResultBase.error" } }, { "id": 2543, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:common" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisCommonResultBase.kind" } }, { "id": 2540, "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": "RedisCommonResultBase.ok" } }, { "id": 2539, "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": "RedisCommonResultBase.processed" } }, { "id": 2542, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCommonResultBase.value", "package": "@probitas-test/client-redis" } } ], "typeParameters": [ { "id": 2538, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisCommonResultBase" }, "typeArguments": [ { "type": "reference", "target": 2538, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisCommonResultFailure.T", "refersToTypeParameter": true } ], "name": "RedisCommonResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2521, "name": "RedisCommonResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful common result." } ] }, "children": [ { "id": 2528, "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": "RedisCommonResultBase.duration" } }, { "id": 2525, "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": "RedisCommonResultBase.error" } }, { "id": 2527, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:common" }, "inheritedFrom": { "type": "reference", "target": 2535, "name": "RedisCommonResultBase.kind", "package": "@probitas-test/client-redis" } }, { "id": 2524, "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": "RedisCommonResultBase.ok" } }, { "id": 2523, "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": "RedisCommonResultBase.processed" } }, { "id": 2526, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 2522, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisCommonResultSuccess.T", "refersToTypeParameter": true }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCommonResultBase.value", "package": "@probitas-test/client-redis" } } ], "typeParameters": [ { "id": 2522, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisCommonResultBase" }, "typeArguments": [ { "type": "reference", "target": 2522, "name": "T", "package": "@probitas-test/client-redis", "qualifiedName": "RedisCommonResultSuccess.T", "refersToTypeParameter": true } ], "name": "RedisCommonResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2176, "name": "RedisConnectionConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis connection configuration.\n\nExtends CommonConnectionConfig with Redis-specific options." } ] }, "children": [ { "id": 2177, "name": "db", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Database index." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n0\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2178, "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": 2181, "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": 2179, "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": 2180, "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": 2458, "name": "RedisCountResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Count result with Redis error." } ] }, "children": [ { "id": 2464, "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": "RedisCountResultBase.duration" } }, { "id": 2461, "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": 2805, "name": "RedisOperationError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCountResultBase.error" } }, { "id": 2463, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:count" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisCountResultBase.kind" } }, { "id": 2460, "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": "RedisCountResultBase.ok" } }, { "id": 2459, "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": "RedisCountResultBase.processed" } }, { "id": 2462, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCountResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisCountResultBase" }, "name": "RedisCountResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2465, "name": "RedisCountResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Count result with connection failure." } ] }, "children": [ { "id": 2471, "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": "RedisCountResultBase.duration" } }, { "id": 2468, "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": 2804, "name": "RedisFailureError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCountResultBase.error" } }, { "id": 2470, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:count" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisCountResultBase.kind" } }, { "id": 2467, "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": "RedisCountResultBase.ok" } }, { "id": 2466, "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": "RedisCountResultBase.processed" } }, { "id": 2469, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCountResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisCountResultBase" }, "name": "RedisCountResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2451, "name": "RedisCountResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful count result." } ] }, "children": [ { "id": 2457, "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": "RedisCountResultBase.duration" } }, { "id": 2454, "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": "RedisCountResultBase.error" } }, { "id": 2456, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:count" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisCountResultBase.kind" } }, { "id": 2453, "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": "RedisCountResultBase.ok" } }, { "id": 2452, "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": "RedisCountResultBase.processed" } }, { "id": 2455, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisCountResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisCountResultBase" }, "name": "RedisCountResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2758, "name": "RedisErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for Redis errors." } ] }, "children": [ { "id": 2759, "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": 2777, "name": "RedisCommandErrorOptions" }, { "type": "reference", "target": 2789, "name": "RedisScriptErrorOptions" } ] }, { "id": 2414, "name": "RedisGetResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "GET result with Redis error." } ] }, "children": [ { "id": 2420, "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": 2420, "name": "RedisGetResultBase.duration", "package": "@probitas-test/client-redis", "qualifiedName": "RedisResultBase.duration" } }, { "id": 2417, "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": 2805, "name": "RedisOperationError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisGetResultBase.error" } }, { "id": 2419, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:get" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisGetResultBase.kind" } }, { "id": 2416, "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": "RedisGetResultBase.ok" } }, { "id": 2415, "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": "RedisGetResultBase.processed" } }, { "id": 2418, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisGetResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisGetResultBase" }, "name": "RedisGetResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2421, "name": "RedisGetResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "GET result with connection failure." } ] }, "children": [ { "id": 2427, "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": 2420, "name": "RedisGetResultBase.duration", "package": "@probitas-test/client-redis", "qualifiedName": "RedisResultBase.duration" } }, { "id": 2424, "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": 2804, "name": "RedisFailureError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisGetResultBase.error" } }, { "id": 2426, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:get" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisGetResultBase.kind" } }, { "id": 2423, "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": "RedisGetResultBase.ok" } }, { "id": 2422, "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": "RedisGetResultBase.processed" } }, { "id": 2425, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisGetResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisGetResultBase" }, "name": "RedisGetResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2407, "name": "RedisGetResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful GET result." } ] }, "children": [ { "id": 2413, "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": 2420, "name": "RedisGetResultBase.duration", "package": "@probitas-test/client-redis", "qualifiedName": "RedisResultBase.duration" } }, { "id": 2410, "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": "RedisGetResultBase.error" } }, { "id": 2412, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:get" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisGetResultBase.kind" } }, { "id": 2409, "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": "RedisGetResultBase.ok" } }, { "id": 2408, "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": "RedisGetResultBase.processed" } }, { "id": 2411, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "RedisGetResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisGetResultBase" }, "name": "RedisGetResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2506, "name": "RedisHashResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Hash result with Redis error." } ] }, "children": [ { "id": 2512, "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": "RedisHashResultBase.duration" } }, { "id": 2509, "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": 2805, "name": "RedisOperationError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisHashResultBase.error" } }, { "id": 2511, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:hash" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisHashResultBase.kind" } }, { "id": 2508, "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": "RedisHashResultBase.ok" } }, { "id": 2507, "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": "RedisHashResultBase.processed" } }, { "id": 2510, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisHashResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisHashResultBase" }, "name": "RedisHashResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2513, "name": "RedisHashResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Hash result with connection failure." } ] }, "children": [ { "id": 2519, "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": "RedisHashResultBase.duration" } }, { "id": 2516, "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": 2804, "name": "RedisFailureError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisHashResultBase.error" } }, { "id": 2518, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:hash" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisHashResultBase.kind" } }, { "id": 2515, "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": "RedisHashResultBase.ok" } }, { "id": 2514, "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": "RedisHashResultBase.processed" } }, { "id": 2517, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisHashResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisHashResultBase" }, "name": "RedisHashResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2499, "name": "RedisHashResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful hash result." } ] }, "children": [ { "id": 2505, "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": "RedisHashResultBase.duration" } }, { "id": 2502, "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": "RedisHashResultBase.error" } }, { "id": 2504, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:hash" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisHashResultBase.kind" } }, { "id": 2501, "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": "RedisHashResultBase.ok" } }, { "id": 2500, "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": "RedisHashResultBase.processed" } }, { "id": 2503, "name": "value", "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" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisHashResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisHashResultBase" }, "name": "RedisHashResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2173, "name": "RedisMessage", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis Pub/Sub message" } ] }, "children": [ { "id": 2174, "name": "channel", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2175, "name": "message", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 2789, "name": "RedisScriptErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for Redis script errors." } ] }, "children": [ { "id": 2791, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 2759, "name": "RedisErrorOptions.code" } }, { "id": 2790, "name": "script", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": 2758, "name": "RedisErrorOptions", "package": "@probitas-test/client-redis" } ] }, { "id": 2164, "name": "RedisSetOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis SET options" } ] }, "children": [ { "id": 2165, "name": "ex", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Expiration in seconds" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2167, "name": "nx", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Only set if key does not exist" } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 2166, "name": "px", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Expiration in milliseconds" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2172, "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": 2163, "name": "RedisCommandOptions.retry" } }, { "id": 2171, "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": 2162, "name": "RedisCommandOptions.signal" } }, { "id": 2169, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw an error when the operation fails.\n\nWhen " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", failures will throw an error instead of returning a result\nwith " }, { "kind": "code", "text": "`ok: false`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse (inherited from client config or defaults to false)\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": 2160, "name": "RedisCommandOptions.throwOnError" } }, { "id": 2170, "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": 2161, "name": "RedisCommandOptions.timeout" } }, { "id": 2168, "name": "xx", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Only set if key exists" } ] }, "type": { "type": "intrinsic", "name": "boolean" } } ], "extendedTypes": [ { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } ] }, { "id": 2436, "name": "RedisSetResultError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SET result with Redis error." } ] }, "children": [ { "id": 2442, "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": "RedisSetResultBase.duration" } }, { "id": 2439, "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": 2805, "name": "RedisOperationError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisSetResultBase.error" } }, { "id": 2441, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:set" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisSetResultBase.kind" } }, { "id": 2438, "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": "RedisSetResultBase.ok" } }, { "id": 2437, "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": "RedisSetResultBase.processed" } }, { "id": 2440, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisSetResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisSetResultBase" }, "name": "RedisSetResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2443, "name": "RedisSetResultFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "SET result with connection failure." } ] }, "children": [ { "id": 2449, "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": "RedisSetResultBase.duration" } }, { "id": 2446, "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": 2804, "name": "RedisFailureError", "package": "@probitas-test/client-redis" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisSetResultBase.error" } }, { "id": 2448, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:set" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisSetResultBase.kind" } }, { "id": 2445, "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": "RedisSetResultBase.ok" } }, { "id": 2444, "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": "RedisSetResultBase.processed" } }, { "id": 2447, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "RedisSetResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisSetResultBase" }, "name": "RedisSetResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2429, "name": "RedisSetResultSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful SET result." } ] }, "children": [ { "id": 2435, "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": "RedisSetResultBase.duration" } }, { "id": 2432, "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": "RedisSetResultBase.error" } }, { "id": 2434, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "type": { "type": "literal", "value": "redis:set" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RedisSetResultBase.kind" } }, { "id": 2431, "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": "RedisSetResultBase.ok" } }, { "id": 2430, "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": "RedisSetResultBase.processed" } }, { "id": 2433, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "OK" }, "overwrites": { "type": "reference", "target": -1, "name": "RedisSetResultBase.value", "package": "@probitas-test/client-redis" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-redis", "packagePath": "result.ts", "qualifiedName": "RedisSetResultBase" }, "name": "RedisSetResultBase", "package": "@probitas-test/client-redis" } ] }, { "id": 2188, "name": "RedisTransaction", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis transaction interface" } ] }, "children": [ { "id": 2203, "name": "decr", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2204, "name": "decr", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2205, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2197, "name": "del", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2198, "name": "del", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2199, "name": "keys", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2278, "name": "discard", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2279, "name": "discard", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "intrinsic", "name": "void" } } ] }, { "id": 2275, "name": "exec", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2276, "name": "exec", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2277, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2159, "name": "RedisCommandOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2497, "typeArguments": [ { "type": "intrinsic", "name": "unknown" } ], "name": "RedisArrayResult", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 2189, "name": "get", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2190, "name": "get", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2191, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2218, "name": "hdel", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2219, "name": "hdel", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2220, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2221, "name": "fields", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2206, "name": "hget", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2207, "name": "hget", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2208, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2209, "name": "field", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2215, "name": "hgetall", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2216, "name": "hgetall", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2217, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2210, "name": "hset", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2211, "name": "hset", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2212, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2213, "name": "field", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2214, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2200, "name": "incr", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2201, "name": "incr", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2202, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2241, "name": "llen", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2242, "name": "llen", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2243, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2230, "name": "lpop", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2231, "name": "lpop", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2232, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2222, "name": "lpush", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2223, "name": "lpush", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2224, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2225, "name": "values", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2236, "name": "lrange", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2237, "name": "lrange", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2238, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2239, "name": "start", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2240, "name": "stop", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2233, "name": "rpop", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2234, "name": "rpop", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2235, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2226, "name": "rpush", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2227, "name": "rpush", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2228, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2229, "name": "values", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2244, "name": "sadd", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2245, "name": "sadd", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2246, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2247, "name": "members", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2192, "name": "set", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2193, "name": "set", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2194, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2195, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2196, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 2164, "name": "RedisSetOptions", "package": "@probitas-test/client-redis" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2255, "name": "sismember", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2256, "name": "sismember", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2257, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2258, "name": "member", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2252, "name": "smembers", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2253, "name": "smembers", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2254, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2248, "name": "srem", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2249, "name": "srem", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2250, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2251, "name": "members", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2259, "name": "zadd", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2260, "name": "zadd", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2261, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2262, "name": "entries", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 2263, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 2265, "name": "member", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2264, "name": "score", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ] } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2266, "name": "zrange", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2267, "name": "zrange", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2268, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2269, "name": "start", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 2270, "name": "stop", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 2271, "name": "zscore", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 2272, "name": "zscore", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 2273, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 2274, "name": "member", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] } ] }, { "id": 2497, "name": "RedisArrayResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis array result (LRANGE, SMEMBERS, etc.)." } ] }, "typeParameters": [ { "id": 2498, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 2473, "typeArguments": [ { "type": "reference", "target": 2498, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisArrayResultSuccess", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2481, "typeArguments": [ { "type": "reference", "target": 2498, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisArrayResultError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2489, "typeArguments": [ { "type": "reference", "target": 2498, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisArrayResultFailure", "package": "@probitas-test/client-redis" } ] } }, { "id": 2545, "name": "RedisCommonResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis operation result (common/generic).\n\nUsed for operations without a more specific result type." } ] }, "typeParameters": [ { "id": 2546, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 2521, "typeArguments": [ { "type": "reference", "target": 2546, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisCommonResultSuccess", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2529, "typeArguments": [ { "type": "reference", "target": 2546, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisCommonResultError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2537, "typeArguments": [ { "type": "reference", "target": 2546, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisCommonResultFailure", "package": "@probitas-test/client-redis" } ] } }, { "id": 2472, "name": "RedisCountResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis numeric result (DEL, LPUSH, SADD, etc.)." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 2451, "name": "RedisCountResultSuccess", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2458, "name": "RedisCountResultError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2465, "name": "RedisCountResultFailure", "package": "@probitas-test/client-redis" } ] } }, { "id": 2804, "name": "RedisFailureError", "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 Redis server." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 2769, "name": "RedisConnectionError", "package": "@probitas-test/client-redis" }, { "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": 2428, "name": "RedisGetResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis GET result." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 2407, "name": "RedisGetResultSuccess", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2414, "name": "RedisGetResultError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2421, "name": "RedisGetResultFailure", "package": "@probitas-test/client-redis" } ] } }, { "id": 2520, "name": "RedisHashResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis hash result (HGETALL)." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 2499, "name": "RedisHashResultSuccess", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2506, "name": "RedisHashResultError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2513, "name": "RedisHashResultFailure", "package": "@probitas-test/client-redis" } ] } }, { "id": 2805, "name": "RedisOperationError", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error types that indicate the operation was processed but failed.\nThese are errors returned by the Redis server." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 2780, "name": "RedisCommandError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2792, "name": "RedisScriptError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2760, "name": "RedisError", "package": "@probitas-test/client-redis" } ] } }, { "id": 2547, "name": "RedisResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Union of all Redis result types." } ] }, "typeParameters": [ { "id": 2548, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 2545, "typeArguments": [ { "type": "reference", "target": 2548, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisCommonResult", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2428, "name": "RedisGetResult", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2450, "name": "RedisSetResult", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2472, "name": "RedisCountResult", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2497, "typeArguments": [ { "type": "reference", "target": 2548, "name": "T", "package": "@probitas-test/client-redis", "refersToTypeParameter": true } ], "name": "RedisArrayResult", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2520, "name": "RedisHashResult", "package": "@probitas-test/client-redis" } ] } }, { "id": 2450, "name": "RedisSetResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis SET result." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 2429, "name": "RedisSetResultSuccess", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2436, "name": "RedisSetResultError", "package": "@probitas-test/client-redis" }, { "type": "reference", "target": 2443, "name": "RedisSetResultFailure", "package": "@probitas-test/client-redis" } ] } }, { "id": 2801, "name": "createRedisClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 2802, "name": "createRedisClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new Redis client instance.\n\nThe client provides comprehensive Redis data structure support including strings,\nhashes, lists, sets, sorted sets, pub/sub, and transactions." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise resolving to a new Redis client instance" } ] }, { "tag": "@example", "name": "Using URL string", "content": [ { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({\n url: \"redis://localhost:6379/0\",\n});\n\nawait client.set(\"key\", \"value\");\nconst result = await client.get(\"key\");\nif (result.ok) {\n console.log(result.value); // \"value\"\n}\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using connection config object", "content": [ { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({\n url: {\n host: \"localhost\",\n port: 6379,\n password: \"secret\",\n db: 0,\n },\n});\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Set with expiration", "content": [ { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({ url: \"redis://localhost:6379\" });\nconst sessionData = JSON.stringify({ userId: \"123\" });\nconst data = \"temporary value\";\n\n// Set key with 1 hour TTL\nawait client.set(\"session\", sessionData, { ex: 3600 });\n\n// Set key with 5 second TTL in milliseconds\nawait client.set(\"temp\", data, { px: 5000 });\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Hash operations", "content": [ { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({ url: \"redis://localhost:6379\" });\n\nawait client.hset(\"user:123\", \"name\", \"Alice\");\nawait client.hset(\"user:123\", \"email\", \"alice@example.com\");\n\nconst user = await client.hgetall(\"user:123\");\nif (user.ok) {\n console.log(user.value); // { name: \"Alice\", email: \"alice@example.com\" }\n}\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Pub/Sub", "content": [ { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nconst client = await createRedisClient({ url: \"redis://localhost:6379\" });\n\n// Subscribe to channel (this would run indefinitely in practice)\n// for await (const message of client.subscribe(\"events\")) {\n// console.log(\"Received:\", message.message);\n// }\n\n// Publish to channel\nawait client.publish(\"events\", JSON.stringify({ type: \"user.created\" }));\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createRedisClient } from \"@probitas-test/client-redis\";\n\nawait using client = await createRedisClient({\n url: \"redis://localhost:6379\",\n});\n\nawait client.set(\"test\", \"value\");\n// Client automatically closed when scope exits\n```" } ] } ] }, "parameters": [ { "id": 2803, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Redis client configuration" } ] }, "type": { "type": "reference", "target": 2182, "name": "RedisClientConfig", "package": "@probitas-test/client-redis" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 2280, "name": "RedisClient", "package": "@probitas-test/client-redis" } ], "name": "Promise", "package": "typescript" } } ] } ], "packageName": "@probitas-test/client-redis", "packageVersion": "0.5.2" }