@envelop/response-cache-redis 0.5.0-alpha-26c4ae2.0 → 0.5.0

package/README.md

@@ -0,0 +1,89 @@
+## `@envelop/response-cache-redis`
+
+- Supports redis cache for `@envelop/response-cache` plugin
+- Suitable for serveless deployments where the LRU In-Memory Cache is not possible
+
+[Check out the GraphQL Response Cache Guide for more information](https://envelop.dev/docs/guides/adding-a-graphql-response-cache)
+
+## Getting Started
+
+```bash
+yarn add @envelop/response-cache
+yarn add @envelop/response-cache-redis
+```
+
+## Usage Example
+
+In order to use the Redis cache, you need to:
+
+- Create a Redis database
+- Collect the connection settings (or its connection string), e.g., `host`, `port`, `username`, `password`, `tls`, etc.
+- Create and configure a [Redis client](https://github.com/luin/ioredis) with your [connection settings](https://github.com/luin/ioredis/blob/master/API.md#Redis) and any [additional options](https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new)
+- Create an instance of the Redis Cache and set to the `useResponseCache` plugin options
+
+```ts
+
+import { envelop } from '@envelop/core';
+import { useResponseCache } from '@envelop/response-cache';
+import { createRedisCache } from '@envelop/response-cache-redis';
+
+import Redis from 'ioredis';
+
+/**
+ * For additional Redis options to create the ioredis client
+ * @see: https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new
+ *
+ **/
+const redis = new Redis({
+  host: 'my-redis-db.example.com',
+  port: '30652',
+  password: '1234567890',
+});
+
+// or, you can also specify connection options as a redis:// URL or rediss:// URL when using TLS encryption
+const redis = new Redis(("rediss://:1234567890@my-redis-db.example.com':30652");
+
+const cache = createRedisCache({ redis });
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useResponseCache({ cache }),
+  ],
+});
+```
+
+### Invalidate Cache based on custom logic
+
+```ts
+import { envelop } from '@envelop/core';
+import { useResponseCache } from '@envelop/response-cache';
+import { createRedisCache } from '@envelop/response-cache-redis';
+
+import { emitter } from './eventEmitter';
+
+// we create our cache instance, which allows calling all methods on it
+const redis = new Redis(("rediss://:1234567890@my-redis-db.example.com':30652");
+
+const cache = createRedisCache({ redis });
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useResponseCache({
+      ttl: 2000,
+      // we pass the cache instance to the request.
+      cache,
+    }),
+  ],
+});
+
+emitter.on('invalidate', resource => {
+  cache.invalidate([
+    {
+      typename: resource.type,
+      id: resource.id,
+    },
+  ]);
+});
+```

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@envelop/response-cache-redis",
-  "version": "0.5.0-alpha-26c4ae2.0",
+  "version": "0.5.0",
   "sideEffects": false,
   "peerDependencies": {},
   "dependencies": {
-    "@envelop/response-cache": "2.4.0-alpha-26c4ae2.0",
+    "@envelop/response-cache": "^2.4.0",
     "ioredis": "^4.27.9"
   },
   "repository": {