feat(core): effects can optionally return a cleanup function #49625
Conversation
pkozlowski-opensource
added
area: core
pkozlowski-opensource
force-pushed
the
reactivity_signals_effects_return_value
branch
from
f31ce00
to
4af6b21
Compare
pkozlowski-opensource
added
the
action: review
|
|
||
| constructor(private watch: () => void, private schedule: (watch: Watch) => void) { | ||
| constructor(private watch: () => void|WatchCleanupFn, private schedule: (watch: Watch) => void) { |
There was a problem hiding this comment.
nit: () => void|WatchCleanupFn seems superfluous, it's a union on identical types.
There was a problem hiding this comment.
Oh wait, I've meant () => (void|WatchCleanupFn) - it is a function that can return another (cleanup) function.
There was a problem hiding this comment.
| } finally { | ||
| setActiveConsumer(prevConsumer); | ||
| } | ||
| } | ||
|
|
||
| cleanup() { | ||
| this.cleanupFn(); |
There was a problem hiding this comment.
This is fine for now, but longer-term we should think about these long-lived operations and error handling. What should happen if an effect or its cleanup function throws an error?
There was a problem hiding this comment.
Agreed. Making a note for myself.
pkozlowski-opensource
force-pushed
the
reactivity_signals_effects_return_value
branch
from
4af6b21
to
7288009
Compare
|
For anyone wanting to see a real case scenario: https://stackblitz.com/edit/angular-pknifp?file=src%2Fmain.ts (shared on twitter by @lifekefunde) |
pkozlowski-opensource
force-pushed
the
reactivity_signals_effects_return_value
branch
from
7288009
to
32f9341
Compare
pkozlowski-opensource
added
action: merge
This change extends the effect API surface so effects can, optionally, return a cleanup function. Such function, if returned, is executed prior to the subsequent effect run.
pkozlowski-opensource
force-pushed
the
reactivity_signals_effects_return_value
branch
from
32f9341
to
53fdc46
Compare
|
This PR was merged into the repository by commit 9c5fd50. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
This change extends the effect API surface so effects can, optionally, return a cleanup function. Such function, if returned, is executed prior to the subsequent effect run.