docs(typescript): fix union type terminology#4839
Merged
timdorr merged 1 commit intoJan 30, 2026
Merged
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
✅ Deploy Preview for redux-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Update documentation to correctly identify the loading state pattern as a string union type rather than an enum in both the explanatory text and the code example comments. The current documentation refers to 'idle' | 'pending' | 'succeeded' | 'failed' as "enum values." In TypeScript, this is specifically a string union type. This change improves technical accuracy for users learning Redux Toolkit with TypeScript.
BonaventureCJ
force-pushed
the
docs/correct-loading-state-typescript-terminology
branch
from
57e07c6 to
02b46b5
Compare
Member
|
|
Contributor
Author
|
type Reply = "Much appreciated 🙏"; |
BonaventureCJ
deleted the
docs/correct-loading-state-typescript-terminology
branch
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
2 participants
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.
Update documentation to correctly identify the loading state pattern as a string union type rather than an enum in both the explanatory text and the code example comments.
The current documentation refers to 'idle' | 'pending' | 'succeeded' | 'failed' as "enum values." In TypeScript, this is specifically a string union type. This change improves technical accuracy for users learning Redux Toolkit with TypeScript.
Updated:
Summary:
This PR standardizes terminology across the Redux Essentials, Part 5: Async Logic and Data Fetching guide. It corrects multiple instances where TypeScript String Union Types were inaccurately referred to as "enums."
Changes:
Updated introductory text in the "Loading State" section.
Corrected inline code comments in state examples.
Standardized references in the Thunk lifecycle and React component sections.
Ensures technical accuracy for developers learning RTK with TypeScript.
Why this is necessary:
The current documentation refers to 'idle' | 'pending' | 'succeeded' | 'failed' as "enum values." In TypeScript, this pattern is specifically a string union type. Labeling it an "enum" can be misleading for developers, as Enums in TypeScript are a distinct feature with runtime implications. This change ensures technical accuracy and consistent nomenclature for users learning Redux Toolkit in a TypeScript environment.
name: 📝 Documentation Fix
about: Fixing a problem in an existing docs page
Checklist
What docs page needs to be fixed?
What is the problem?
What changes does this PR make to fix the problem?