Version 1.0

Author: smithamax

.github/workflows/npm-publish.yml

@@ -40,16 +40,16 @@ jobs:
       - run: npm run lint
       - run: ./scripts/example-check.sh
 
-  # publish:
-  #   needs: ["test", "lint"]
-  #   runs-on: ubuntu-latest
-
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - uses: actions/setup-node@v4
-  #       with:
-  #         node-version: 20
-  #     - run: npm ci
-  #     - uses: JS-DevTools/npm-publish@v1
-  #       with:
-  #         token: ${{ secrets.NPM_TOKEN }}
+  publish:
+    needs: ["test", "lint"]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

README.md

@@ -15,9 +15,11 @@ const logger = createLogger();
 const redisClient = new Redis();
 
 const cache = new Cache(
-  "users:{userId}",
-  // Caches will be checked in order, and the first cache to return a value
-  // will be used
+  // Keys should be prefixed with the project name to make them unique across
+  // all of LOKE
+  "foo-service:users:fetch:{userId}",
+  // Cache stores will be checked in order, and the first cache to return a
+  // value will be used
   [new LruMemoryCacheStore({ max: 1000 }), new RedisCacheStore(redisClient)],
   logger,
 );

src/redis.ts

@@ -44,7 +44,6 @@ export class RedisCacheStore<T> implements CacheStore<T> {
     const buf = Buffer.from(JSON.stringify(record), "utf8");
 
     if (this.keyTemplate !== null) {
-      // JS UTF-16 is 2 bytes per char, 🤞redis client isn't using utf8
       cacheValueSize.observe({ key: this.keyTemplate }, buf.length);
     }