solidjs / solid

A declarative, efficient, and flexible JavaScript library for building user interfaces.
https://solidjs.com
MIT License
31.64k stars 887 forks source link

Allow classes to be wrapped inside a store #2128

Open timbasel opened 2 months ago

timbasel commented 2 months ago

Summary

This PR allows classes to be wrapped inside a store. It implements the very small change outlined by @Reinhard2019 in the Issue #1661.

Even if the issue was closed as wontfix I do believe that the functionality is tremendously useful. It has no effects on existing code because it is an opt in on a class by class bases.

To make a class wrappable you just define the $WRAP property (I've added a minimal helper function to do this) in the constructor of the class.

class Test {
  constructor() {
    makeWrappable(this);
  }
}
const [store, setStore] = createStore(new Test())

You can even make just individual instances wrap, by calling makeWrappable just on the created instance.

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: ef64150bf90de6eed25aac5fa7ae537ba073433b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

ryansolid commented 5 days ago

Directionally I'm not opposed. I've considered adding symbol or having helpers to do the wrapping. Technically you can add the PROXY symbol to your class and define your own wrapper today.

My thinking though is like MobX there is perhaps more involved than just auto wrapping every property. I think we should consider something like MobX makeObservable if we go this way. And I think that requires a bit more thought than just enabling it.