search

arrow-kt / arrow

Ξ›rrow - Functional companion to Kotlin's Standard Library
http://arrow-kt.io
Other
6.15k stars 443 forks source link

["Request"] Use FlowMarbles in Arrow Fx Coroutines Flow operators documentation #2458

Open nomisRev opened 3 years ago

nomisRev commented 3 years ago

What would you like to see?

Marble diagrams for Flow extensions.

https://github.com/rougsig/flowmarbles

rougsig commented 3 years ago

If needed, i can add the iframe flag for include diagram only, without extra layout. Also i can add extra operators from arrow to diagram, if arrow-kt flow operators can support kotlin/js Smt like that https://flowmarbles.com/#flatMapLatest?iframe=true

nomisRev commented 3 years ago

Hey @rougsig,

If needed, i can add the iframe flag for include diagram only, without extra layout. Also i can add extra operators from arrow to diagram, if arrow-kt flow operators can support kotlin/js

That'd be awesome! 😍 I have no idea how to otherwise go about including this into our Jekyll website πŸ˜… Next month Arrow 1.0.0 will release with JS support, then I'd be happy to contribute it to your repo to add Arrow examples.

rougsig commented 3 years ago

sure no problems

rougsig commented 2 years ago

Hey @nomisRev

Can you tell me which operators you like to see on marble?

nomisRev commented 2 years ago

Hey @rougsig,

My apologies, for the late response. All the extensions on Flow can be found here: https://github.com/arrow-kt/arrow/blob/main/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/flow.kt

I think these are the most interessting ones to show:

The retry extension based on Schedule is going to be hard to show unless we fix it to a specific input. And mapIndexed is probably not worth adding :D

If there is anything I can help with feel free to reach out to me on Kotlin Slack too.

This would be so cool to have. Thanks for your interest to help πŸ™