search

ngxs / store

🚀 NGXS - State Management for Angular
http://ngxs.io
MIT License
3.53k stars 399 forks source link

[Request] Enhance Documentation regarding Action Lifecycle #1004

Closed cuddlecake closed 5 years ago

cuddlecake commented 5 years ago

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[x] Documentation issue or request
[ ] Support request => https://github.com/ngxs/store/blob/master/CONTRIBUTING.md
[ ] Other... Please describe:

There is barely any information regarding the Action Lifecycle.

There is only mention about which phases are available (dispatched, successful, unsuccessful, completed, etc.), and some further documentation on how to cancel actions (but no mention that this affects the Action Lifecycle).

What is the motivation / use case for changing the behavior?

I have only found out through trying out, that actions are errored when one of the reducers associated with the action either throw an Error or return an Error Observable.

splincode commented 5 years ago

it will be very cool if you send us a pull request

cuddlecake commented 5 years ago

I will try to, but I can't say when.

splincode commented 5 years ago

Released in 3.5.0