Add makeStore, makeState, makeMemo utilities #81
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
yeomanse
reviewed
Sep 10, 2024
tests/make/makeStore.t.ts
Outdated
| @@ -0,0 +1,417 @@ | |||
| // Note from Evan: For some reason, my VSCode won't appropriately assess the return type on keys of store objects. For example, when the input store has a key of *count: number*, the returned store's key is typed *count: unknown*. | |||
There was a problem hiding this comment.
Clean these up, make them comments on the PR instead
yeomanse
reviewed
Sep 10, 2024
| value: new Signal.State(value), | ||
| }); | ||
| // Branding for use in stores | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Don't want to expose brand in types |
There was a problem hiding this comment.
for hiding stuff from consumers, you could use a symbol,
e.g.:
const STATE = Symbol.for("__state__");
// ...
(store as any)[STATE] = true;
NullVoxPopuli
requested changes
Sep 10, 2024
|
bunch of correctness errors there and the tests don't pass https://github.com/proposal-signals/signal-utils/actions/runs/11098489258/job/31209230519?pr=81 😅 Would be exciting to merge! |
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.
Adding
makeStore,makeState, andmakeMemofunctions along with corresponding types and unit tests.makeStorehas an optionalisDeepboolean input that can be used to create nested reactivity through recursion. It is false by default, adding only top-level reactivity to passed objects. See implementation and unit tests for explanations on how different types of input keys are handled.makeStateandmakeMemocall upon themakeStorefunction and when invoked behave as individual Signals and Computeds, respectively.Note: Reads/writes for reactive objects created with
makeStateandmakeMemoneed to be done through access to theirvalueproperty - this is by design. However, reactive objects created withmakeStoreallow reads/writes directly on keys of the returned store.