redis-rstream is a Node.js read stream that streams binary or UTF-8 data in chunks from a Redis key using an existing Redis client. It implements the streams2 interface (Node >=0.10) and uses the GETRANGE command to read data in configurable chunk sizes (default 64KB). It supports optional range streaming via startOffset/endOffset. It requires a Redis client that supports getrange and can return Buffers (e.g., node_redis with detect_buffers). Version 1.0.1 is stable but not actively maintained; last updated in 2015. Key differentiator: uses an existing client connection rather than opening a separate Redis connection, which avoids authentication/connection overhead. However, it is superseded by more modern streaming approaches and the package may be unmaintained.
npm install redis-rstreamNo compatibility data collected yet for this library.
Verified import paths — ran on the pinned version, not inferred.
Creates a read stream from a Redis key and pipes it to stdout. Uses a custom chunk size and graceful cleanup.
Use a modern streaming library like ioredis or build a custom stream using async iteration.
Consider migrating to ioredis, which supports native streaming via the stream() method.
Ensure client is created with { detect_buffers: true } or similar option for Buffer returns.Monitor memory usage and consider using a different library for very large Redis keys.
Always pass a valid Redis client instance.
Use const redisRStream = require('redis-rstream'); instead of import.Ensure options are valid and client is properly connected. Check that you are not using 'new'.
Ensure Redis server is running and client connection is established before creating the stream.