@quark-fw/plugin-redis 0.1.26 → 0.1.28

package/README.md

@@ -0,0 +1,29 @@
+# @quark-fw/plugin-redis
+
+Redis (ioredis) client for Quark apps: `quark.redis.client` is an atom holding a lazily connected `Redis` instance, `quark.redis.config` an atom with the connection URL. Sessions (`plugin-auth`), cron locks, the jobs queue, rate limiters and the threads event bridge all share this client.
+
+## Install
+
+```sh
+npm i @quark-fw/plugin-redis
+```
+
+Peer: `@quark-fw/core`. `ioredis` is a dependency.
+
+## Usage
+
+```ts
+import "@quark-fw/plugin-redis"; // provides quark.redis
+
+const redis = quark.redis.client.value; // ioredis instance
+await redis.set("key", "value", "EX", 60);
+
+// switch connection at runtime: a new client is created, the old one is quit
+quark.redis.config.value = { url: "redis://cache:6379" };
+```
+
+How it works: the client is created with `lazyConnect: true` (no connection until the first command), `maxRetriesPerRequest: null`, `family: 4` and a `retryStrategy` of `min(times * 200, 2000)` ms. Read `quark.redis.client.value` where you use it rather than caching it: when `config` changes the plugin replaces the atom value with a new client and quits the old one. `onDestroy` quits the client (falls back to `disconnect()`).
+
+Env: `REDIS_URL` (default `redis://127.0.0.1:6379`; in production the internal URL of the Redis service).
+
+Part of the [Quark framework](https://www.npmjs.com/package/@quark-fw/core).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@quark-fw/plugin-redis",
-	"version": "0.1.26",
+	"version": "0.1.28",
 	"main": "src/index.ts",
 	"types": "src/index.ts",
 	"type": "module",
@@ -21,11 +21,11 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@quark-fw/atom": "0.1.26",
-		"@quark-fw/plugin": "0.1.26",
+		"@quark-fw/atom": "0.1.28",
+		"@quark-fw/plugin": "0.1.28",
 		"ioredis": "^5.9.3"
 	},
 	"peerDependencies": {
-		"@quark-fw/core": "0.1.26"
+		"@quark-fw/core": "0.1.28"
 	}
 }