Docs for StreamListener and fromStream?
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.2k
- Forks
- 130
- PR merge metrics
- No merged PRs in 30d
Description
These two seem to be missing from the docs and have some odd behavior.
I'm trying to wrap an rxjs observable but when using fromStream I noticed two problems:
- There's no way to tell when the observable is completed
- fromStream eats any errors from the observable and assigns them to .current as if they're just another normal value. Shouldn't it throw them instead?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the StreamListener and fromStream entry points and reading how they wrap an RxJS observable. Check the existing documentation and behavior around completion and errors; done means the missing APIs are documented and the reported completion and error handling questions have clear, tested outcomes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100