docs: update README to align with current API#75
Merged
Conversation
- Remove all documentation for non-existent rxStateful$ function - Fix context values by removing non-existent 'complete' value - Emphasize rxRequest as the primary API - Add migration notice about rxStateful$ removal - Update all code examples to use only rxRequest - Add comprehensive examples for rxRequest with and without triggers - Clean up configuration documentation to only reference rxRequest Fixes #61
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.
Summary
rxStateful$function from READMErxRequestas the primary and only APIProblem
As identified in issue #61, the README documentation had drifted from the current API implementation:
rxStateful$function was extensively documented but doesn't exist in the codebase (removed in PR fix: migrate demo app from rxStateful$ to rxRequest #19)Changes Made
rxStateful$standalone function sectionrxRequestonlyrxStateful$removalrxRequestwith and without triggersTesting
nx test rx-stateful✅nx lint rx-stateful✅Fixes #61