Repository navigation
fix(types): export ScanStreamOptions, RedisStatus and ClusterStatus - #2158
Merged
Merged
Conversation
These three types describe the public API but are not exported, so consumers cannot name them and have to re-derive them with Parameters<...>/ReturnType<...> or fall back to a wider type. - ScanStreamOptions is the options parameter of scanStream(), sscanStream(), hscanStream(), zscanStream() and their Buffer variants, on both Redis and Cluster (14 public methods). - RedisStatus is the type of the public 'status' property and of the event names accepted by the on()/once() overloads. - ClusterStatus is the type of Cluster's public 'status' property. ScanStreamOptions was already exported from lib/types.ts and only needed re-exporting; the other two gain an export keyword. No runtime code changes. Adds test/typing/exports.test-d.ts, which imports the three names and checks them against the signatures they describe, so the exports cannot be dropped or drift from their use sites without failing tsd.
PavelPashov
approved these changes
Jul 30, 2026
PavelPashov
left a comment
Contributor
There was a problem hiding this comment.
Thank you for the contribution. LGTM
github-actions Bot
pushed a commit
that referenced
this pull request
Jul 31, 2026
# [6.0.0](v5.11.1...v6.0.0) (2026-07-31) * Add RESP3 ([#2127](#2127)) ([5d0862e](5d0862e)) ### Bug Fixes * clear stale socket timeout on reconnect ([#2148](#2148)) ([6455dbe](6455dbe)) * **cluster:** recreate stale connection on circular MOVED ([#2135](#2135)) ([08c8967](08c8967)) * **cluster:** validate MOVED slot to prevent Array.prototype pollution ([#2151](#2151)) ([9618206](9618206)), closes [#1267](#1267) * **command:** serialize large integer arguments in decimal notation ([#2136](#2136)) ([09b8d04](09b8d04)) * **redis:** keep reconnecting when connection closes during client setup ([#2099](#2099)) ([#2123](#2123)) ([f9a66bc](f9a66bc)) * **sentinel:** preserve zero preferred slave priority ([#2129](#2129)) ([a3f9f2d](a3f9f2d)) * **tracing:** redact values for GETSET and PSETEX ([#2134](#2134)) ([832765d](832765d)) * **types:** export ScanStreamOptions, RedisStatus and ClusterStatus ([#2158](#2158)) ([cf3bf71](cf3bf71)) ### Features * add LMOVEM and BLMOVEM command support ([#2144](#2144)) ([c26af46](c26af46)) * add Redis 8.10 set cardinality commands ([#2143](#2143)) ([301099b](301099b)) * himport managed fieldsets ([#2159](#2159)) ([729f174](729f174)) * improve default connection resilience ([#2160](#2160)) ([6d0716e](6d0716e)) * support MAXCOUNT and MAXSIZE for stream reads ([#2142](#2142)) ([ae5e41b](ae5e41b)) ### BREAKING CHANGES * ioredis now requires Node.js 20 or newer and uses RESP3 by default. Set `protocol: 2` to retain the v5 wire protocol.
|
🎉 This PR is included in version 6.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three types that describe the public API are not exported, so consumers can't name them and end up re-deriving them with
Parameters<...>/ReturnType<...>or widening to something looser.ScanStreamOptionsscanStream(),sscanStream(),hscanStream(),zscanStream()and theirBuffervariants — 14 public methods acrossRedisandClusterRedisStatusstatusproperty, and of the event names accepted by theon()/once()overloadsClusterStatusCluster's publicstatuspropertyScanStreamOptionswas already exported fromlib/types.tsand only needed re-exporting fromlib/index.ts; the other two gain anexportkeyword. No runtime code is touched.Not included:
FlushQueueOptionsis in the same situation but only appears inprivate flushQueue()and an internalDataHandledablemethod, so it doesn't look like public API.Tests
test/typing/exports.test-d.tsimports the three names and checks them against the signatures they describe, so the exports can't be dropped or drift from their use sites withouttsdfailing. Verified by mutation:lib/index.ts→tsdfails with 5 errors (has no exported member ...×3, plus two "Parameter type X is not identical to argument type X");exportkeyword fromtype RedisStatus→ build fails withlib/index.ts(70,15): error TS2614;Verification
npm run test:tsd— passes.npm run lint— rc=0, same 23 warnings as baseline, none in changed lines.prettier --check— same 13 warnings as baseline;lib/cluster/index.tsis flagged on baseline too and the edited region is byte-identical to prettier's output.npm run test:jsagainstdocker:setup(single + cluster, both healthy) — 2545 passing, 34 pending, 6 failing. The six aregeoradiusbymember/georadiusbymember_ro("returns the anchor member within a zero radius", RESP2/legacy + RESP3/legacy + RESP3/resp3). They reproduce identically on unmodifiedmainwith this change stashed, so they're pre-existing and unrelated to this PR.Related: #1880 asked for
RedisStatusto be exported; it was closed automatically as stale, with no maintainer decision on it.Note
Low Risk
Type-only surface area with no runtime changes; risk is limited to accidental export removal or type drift, which tsd guards against.
Overview
Exports three public API types so TypeScript consumers can import them by name instead of using
Parameters<...>/ReturnType<...>.ScanStreamOptionsis re-exported from the package entry (lib/index.ts); it already existed inlib/types.ts.RedisStatusandClusterStatusare now exported from their defining modules (lib/Redis.ts,lib/cluster/index.ts) and re-exported fromlib/index.ts. No runtime behavior changes.Adds
test/typing/exports.test-d.tswith tsd checks that these exports stay aligned withscanStreamoptions,Redis.status, andCluster.status.Reviewed by Cursor Bugbot for commit c5416d6. Bugbot is set up for automated code reviews on this repo. Configure here.