Skip to content

docs: update README to align with current API#75

Merged
michaelbe812 merged 2 commits into
mainfrom
fix/update-readme-api-alignment
Sep 16, 2025
Merged

docs: update README to align with current API#75
michaelbe812 merged 2 commits into
mainfrom
fix/update-readme-api-alignment

Conversation

@michaelbe812

Copy link
Copy Markdown
Owner

Summary

  • Remove all references to the non-existent rxStateful$ function from README
  • Update documentation to emphasize rxRequest as the primary and only API
  • Fix incorrect context values and ensure accuracy with current implementation

Problem

As identified in issue #61, the README documentation had drifted from the current API implementation:

  1. rxStateful$ function was extensively documented but doesn't exist in the codebase (removed in PR fix: migrate demo app from rxStateful$ to rxRequest #19)
  2. Documentation mentioned 'complete' as a context value, but it doesn't exist in the type definitions
  3. Examples showed code that wouldn't work with the current library

Changes Made

  • ✅ Removed entire rxStateful$ standalone function section
  • ✅ Fixed context values (removed non-existent 'complete')
  • ✅ Updated all code examples to use rxRequest only
  • ✅ Added migration notice about rxStateful$ removal
  • ✅ Added comprehensive examples for rxRequest with and without triggers
  • ✅ Cleaned up configuration and refresh strategy documentation

Testing

  • All README code examples have been verified to compile correctly
  • All tests pass: nx test rx-stateful
  • All linting passes: nx lint rx-stateful

Fixes #61

Mac Mini and others added 2 commits September 16, 2025 07:52
- 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
@michaelbe812
michaelbe812 merged commit 9555039 into main Sep 16, 2025
1 check passed
@michaelbe812
michaelbe812 deleted the fix/update-readme-api-alignment branch September 16, 2025 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README to align with current API and de-emphasize rxStateful$

1 participant