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.

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

Allow classes to be wrapped inside a store #2128

Closed
wants to merge 0 commits into from

Conversation

timbasel
Copy link

@timbasel timbasel commented Apr 14, 2024

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.

Copy link

changeset-bot bot commented Apr 14, 2024

⚠️ No Changeset found

Latest commit: bb6ce8b

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
Copy link
Member

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.

@timbasel
Copy link
Author

timbasel commented Jul 9, 2024

Just using $PROXY unfortunately did not work for me. I can't remember what exactly broke, but I can check if want.

I'm not really familiar with MobX and have just looked at the documentation for makeObservable, but from my perspective it just over-complicates the matter. For my use case I just want to treat a class instance the same as a basic object when creating a store from it.
In my project I have a few thousand of wrapped class instances and I have not noticed any performance issues or differences.

@timbasel
Copy link
Author

timbasel commented Oct 18, 2024

@ryansolid This PR has been stale for a long time. Is there anything more I can do.

@timbasel
Copy link
Author

timbasel commented Oct 20, 2024

@ryansolid This change is definitely not necessary. Coming back to my project I have just figured out you can just call createStore in the constructor of the class to create instances that are wrapped with the $PROXY.

class Test {
  constructor() {
    createStore(this)
  }
}

const [store, setStore] = createStore({ nested: new Test() });

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants