remove extraneous TCP/IPC properties from RedisOptions TS type #1707
Conversation
This file contains 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
|
Thanks for the contribution! |
github-actions bot
pushed a commit
that referenced
this pull request
Jan 25, 2023
## [5.2.6](v5.2.5...v5.2.6) (2023-01-25) ### Bug Fixes * remove extraneous TCP/IPC properties from RedisOptions TS type ([#1707](#1707)) ([9af7b1c](9af7b1c))
|
🎉 This PR is included in version 5.2.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
luin
pushed a commit
that referenced
this pull request
Apr 15, 2023
luin
pushed a commit
that referenced
this pull request
Apr 15, 2023
## [5.2.6](v5.2.5...v5.2.6) (2023-01-25) ### Bug Fixes * remove extraneous TCP/IPC properties from RedisOptions TS type ([#1707](#1707)) ([9af7b1c](9af7b1c))
janus-dev87
added a commit
to janus-dev87/ioredis-work
that referenced
this pull request
Mar 1, 2024
## [5.2.6](redis/ioredis@v5.2.5...v5.2.6) (2023-01-25) ### Bug Fixes * remove extraneous TCP/IPC properties from RedisOptions TS type ([#1707](redis/ioredis#1707)) ([9af7b1c](redis/ioredis@9af7b1c))
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.
Node 18 introduced a new
keepAliveoption in the TCP socket constructor.This causes ioredis's TypeScript typings to clash with
@types/node, because we definekeepAliveasnumber | undefined, whereas Node defines it as aboolean.Luckily, this isn't a runtime regression. We don't pass
keepAliveintocreateConnection, and in fact only pass in three properties total. But we pretend that any property ofTcpNetConnectOptionscan be included inRedisOptions.This PR reduces the surface-area of
RedisOptionsto only include the TCP and IPC connection parameters that we actually use, which results inkeepAliveonce again having the correct TS type.It should also be less confusing for users, as we've removed several unused properties off of that interface...
Fixes #1680
Fixes #1684