@tillstack/cache-node 0.2.1 → 0.3.0

package/README.md

@@ -0,0 +1,59 @@
+# @tillstack/cache-node
+
+[TillCache](https://tilldev.dev/tillcache) for Node.js: managed key-value storage, durable queues and pub/sub over one HTTPS endpoint and one token, with no Redis cluster to run. The KV methods mirror ioredis.
+
+## Install
+
+```sh
+npm install @tillstack/cache-node
+```
+
+## Connect
+
+Copy the connection string from the dashboard into `TILLCACHE_URL=tillcache://tc_…@cache.tilldev.dev`, then:
+
+```ts
+import { createClient } from '@tillstack/cache-node'
+
+const cache = createClient() // reads TILLCACHE_URL
+```
+
+## KV
+
+```ts
+await cache.set('session:abc', token, { ex: 3600, nx: true })
+await cache.incr('views')
+await cache.hset('user:42', { name: 'Ada', plan: 'pro' })
+await cache.sadd('seen:today', userId)
+await cache.zincrby('leaderboard', 25, 'ada')
+const top = await cache.zrevrange('leaderboard', 0, 9, 'WITHSCORES')
+```
+
+## Queues
+
+```ts
+await cache.queue('emails').push({ to: 'ada@example.com' })
+
+await cache.queue<{ to: string }>('emails').consume(async (msg) => {
+  await sendEmail(msg.body.to) // throw to retry; acked on success
+})
+```
+
+## Pub/sub
+
+```ts
+await cache.publish('presence', { user: 'ada', status: 'online' })
+
+const stop = new AbortController()
+cache.subscribe('presence', (msg) => console.log(msg.message), { signal: stop.signal })
+```
+
+The token only goes over https; plain http is allowed for localhost only.
+
+## Docs
+
+https://tilldev.dev/docs/tillcache/quickstart
+
+## License
+
+Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillstack/cache-node",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "TillCache client for Node.js — managed KV, durable queues and pub/sub over one HTTPS endpoint, with a drop-in ioredis-compatible surface.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -24,7 +24,7 @@
     "dist"
   ],
   "dependencies": {
-    "@tillstack/cache-core": "^0.2.1"
+    "@tillstack/cache-core": "^0.3.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",