cookbook?
- Dominant language
- JavaScript
- Stars
- 3.4k
- Forks
- 145
- PR merge metrics
- No merged PRs in 30d
Description
i've started again with highland.js after becoming aware of it like six months ago. back then i had a hard time grasping the usefulness of the entire concept; in the meantime, i've building up [pipedreams](https://github.com/loveencounterflow/pipedreams), a streaming library of my own that mainly provides utility stuff and ways to cope with some rough edges in the event-stream API. that said, it's in sort of a neglected state because deadline on other stuff. but streaming with pipes is great! this technique has greatly helped me, and when things went wrong and i was at a complete loss i struggled for days to fix that—always feeling the effort was worth the while. now i want to give that pipedreams thing a thorough overhaul (any maybe base it on highland.js); coming back i realize how difficult a lot of the highland sample code is for me to dig. it's also somewhat discouraging to search google for highland.js; you basically always get the same small set of URLs no matter what you asked for as long as the string `highlandjs` appears in the query.
so what i'd suggest is a cookbook of sorts that shows how to do things the streaming way. i have one single example for this [in a note-to-myself style how-to](https://github.com/loveencounterflow/how-to#how-to-keep-order-in-an-asynchronous-world); unfortunately, that code is pseudo, so i still want to make it so it becomes a self-contained minimal working example (MWE) which i think is what cookbooks should provide.
i think [the first few paragraphs to _The introduction to Reactive Programming you've been missing_](https://gist.github.com/staltz/868e7e9bc2a7b8c1f754) reflect my feelings here quite well. let's make it easier to get started!
Contributor guide
Research direction
Start by reviewing Highland's existing sample code and the linked pseudo-code example about keeping order in an asynchronous world. Define a cookbook structure and convert the example into a self-contained minimal working example; done means the examples are runnable and make streaming use cases easier to understand.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100