docs: update SchemaFieldTypes to SCHEMA_FIELD_TYPE for redis@5.x #2992
Conversation
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
nkaradzhov
approved these changes
Jun 6, 2025
|
@23navi thanks for the PR! |
florian-schunk
pushed a commit
to florian-schunk/node-redis
that referenced
this pull request
Jun 18, 2025
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.
Description
docs: fix stale SchemaFieldTypes usage for redis@5.x in search docs
Closes: #2985
Redis v5 introduced a breaking change:
SchemaFieldTypeswas replaced withSCHEMA_FIELD_TYPE[^enum-to-constants].Updated the documentation in
packages/searchto reflect the correct usage:SchemaFieldTypesis correctSCHEMA_FIELD_TYPEmust be usedPrevious docs were misleading and based on pre-v5 enums. This change ensures accurate guidance across versions.
Checklist
npm testpass with this change (including linting)?