Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ jobs:
name: redis-x-stream (Node ${{ matrix.node }})
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
fetch-tags: true
- uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
Expand Down
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
"source.fixAll.eslint": "explicit"
}
}
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ Async iterables over Redis streams. Requires Redis 5+ (6.2+ for `claimIdleTime`)
[![license](https://badgen.net/badge/license/MIT/blue)](https://github.com/calebboyd/redis-x-stream/blob/main/LICENSE)
[![test](https://github.com/calebboyd/redis-x-stream/actions/workflows/test.yml/badge.svg)](https://github.com/calebboyd/redis-x-stream/actions)

## Submodules

This package includes two higher-level modules built on `RedisStream`:

- **[Queue](./src/queue/README.md)** -- Job queue with workers, concurrency, retries, backoff, dead-letter queues, and output streams. `import { Queue, Worker } from 'redis-x-stream/queue'`
- **[Cache](./src/cache/README.md)** -- Distributed single-flight cache with two-tier storage (in-process + Redis), cross-instance broadcast via Redis Streams, and automatic thundering herd prevention. `import { SingleFlightCache } from 'redis-x-stream/cache'`

## Install

```bash
Expand Down
164 changes: 163 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 20 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,25 +39,38 @@
".": {
"import": "./lib/es2018/stream.js",
"require": "./lib/commonjs/stream.js"
},
"./queue": {
"import": "./lib/es2018/queue/index.js",
"require": "./lib/commonjs/queue/index.js"
},
"./cache": {
"import": "./lib/es2018/cache/index.js",
"require": "./lib/commonjs/cache/index.js"
}
},
"type": "module",
"dependencies": {
"debug": "^4.4.3"
},
"peerDependencies": {
"ioredis": "^5.2.0 || ^4.27.0"
"ioredis": "^5.2.0 || ^4.27.0",
"msgpackr": "^1.11.8"
},
"peerDependenciesMeta": {
"msgpackr": {
"optional": true
}
},
"devDependencies": {
"semantic-release": "^25.0.3",
"@commitlint/cli": "^20.4.2",
"@commitlint/config-angular": "^20.4.2",
"@semantic-release/changelog": "^6.0.3",
"@semantic-release/commit-analyzer": "^13.0.1",
"@semantic-release/git": "^10.0.1",
"@semantic-release/github": "^12.0.6",
"@semantic-release/npm": "^13.1.4",
"@semantic-release/release-notes-generator": "^14.1.0",
"@commitlint/cli": "^20.4.2",
"@commitlint/config-angular": "^20.4.2",
"@types/chance": "^1.1.7",
"@types/debug": "^4.1.12",
"@types/node": "^25.3.0",
Expand All @@ -66,6 +79,8 @@
"ioredis": "^5.9.3",
"oxlint": "^1.49.0",
"prettier": "^3.8.1",
"msgpackr": "^1.11.8",
"semantic-release": "^25.0.3",
"typedoc": "^0.28.17",
"typedoc-plugin-markdown": "^4.10.0",
"typescript": "^5.9.3",
Expand Down Expand Up @@ -151,4 +166,4 @@
]
]
}
}
}
Loading
Loading