Switch from Effect to Watcher API #58
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
remove the Effect class Add a watcher class with: constructor: takes options which include the notify callback (and nothing else?). Notify takes no parameters. It is initially in “not watching” mode, and will not notify until put in “watching” mode. Notify is called when one of the signals in the watcher becomes dirty or checked, and when notify is called, the watcher is put into “not watching” mode until the next .watch() call is made. .watch(…signals) adds signals to the watching list and sets the watcher back in “watching” mode. You can call it with no parameters after processing the notify is done, just to reactivate it .getPending() returns an array of the signals which are in the watcher and currently in a pending or dirty state. If it were possible to call this during notify, it would always be nonempty, but notify is only allowed to queue a call to this function. .unwatch() removes a signal (or several) from the watcher .contents() introspects over the set of signals which have been watched [Symbol.dispose] is a shortcut for watcher.unwatch(…watcher.contents()) The separation of notify vs getPending ends up implementing what Michel asked for earlier, of a way of querying whether an effect is dirty There is no replacement for the effect cleanup option, as that can be easily implemented on top (it was always just a convenience feature) So the batching is done by not calling notify again until the next watch call. At the same time, notify is called really soon, just like with effects today.
EisenbergEffect
approved these changes
Feb 13, 2024
|
I wasn't there for the discussions on this change, but reading through the updates, it looks good to me. In my own experimentation with the previous version of the API, I did get into situations where having an explicit watcher rather than an effect would have been better. I also think this will be more easily integrateable into some of the previous systems I've worked on, such as FAST. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.