Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make clear that Signal.State has no state machine #234

Merged
merged 5 commits into from
Aug 6, 2024
Merged

Make clear that Signal.State has no state machine #234

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2220587
Clarify that this construct is specifically for State
prophile Aug 1, 2024
1aca4a4
Remove reference to `state` on `Signal.State`
prophile Aug 1, 2024
ac1f6bd
Clarify that `getPending` only refers to computed signals
prophile Aug 1, 2024
aba5f4e
Clarify that the recursive search only applies to Computed Signals
prophile Aug 1, 2024
aa654ab
Merge branch 'main' into no-state-on-state
littledan Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,14 +462,13 @@ Signal algorithms need to reference certain global state. This state is global f
- `unwatched`: The callback to be called when the signal is no longer observed by an effect
- `sinks`: Set of watched signals which depend on this one

#### Constructor: `Signal(initialValue, options)`
#### Constructor: `Signal.State(initialValue, options)`

1. Set this Signal's `value` to `initialValue`.
1. Set this Signal's `equals` to options?.equals
1. Set this Signal's `watched` to options?.[Signal.subtle.watched]
1. Set this Signal's `unwatched` to options?.[Signal.subtle.unwatched]
1. Set this Signal's `sinks` to the empty set
1. Set `state` to `~clean~`.

#### Method: `Signal.State.prototype.get()`

Expand Down Expand Up @@ -552,7 +551,7 @@ With [AsyncContext](https://github.com/tc39/proposal-async-context), the callbac
1. If `computing` is not `undefined`, add this Signal to `computing`'s `sources` set.
1. NOTE: We do not add `computing` to this Signal's `sinks` set until/unless it becomes watched by a Watcher.
1. If this Signal's state is `~dirty~` or `~checked~`: Repeat the following steps until this Signal is `~clean~`:
1. Recurse up via `sources` to find the deepest, left-most (i.e. earliest observed) recursive source which is marked `~dirty~` (cutting off search when hitting a `~clean~` Signal, and including this Signal as the last thing to search).
1. Recurse up via `sources` to find the deepest, left-most (i.e. earliest observed) recursive source which is a Computed Signal marked `~dirty~` (cutting off search when hitting a `~clean~` Computed Signal, and including this Computed Signal as the last thing to search).
1. Perform the "recalculate dirty computed Signal" algorithm on that Signal.
1. At this point, this Signal's state will be `~clean~`, and no recursive sources will be `~dirty~` or `~checked~`. Return the Signal's `value`. If the value is an exception, rethrow that exception.

Expand Down Expand Up @@ -627,7 +626,7 @@ With [AsyncContext](https://github.com/tc39/proposal-async-context), the callbac

#### Method: `Signal.subtle.Watcher.prototype.getPending()`

1. Return an Array containing the subset of `signals` which are in the state `dirty` or `pending`.
1. Return an Array containing the subset of `signals` which are Computed Signals in the states `~dirty~` or `~pending~`.

### Method: `Signal.subtle.untrack(cb)`

Expand Down
Loading