Skip to content

feat: world now can lazy init, no longer cleans itself up #148

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

krispya
Copy link
Member

@krispya krispya commented Aug 1, 2025

World has a side effect, it registers itself with the universe on init. This is fine in most cases, because dispose is called to clean this up. However, in cases like React a new world is created and discarded in a useMemo leaving side effects without any cleanup. I experimented with fixing this by implementing FinalizationRegistry with Weakrefs, allowing the world to get garbage collected and unbind its link at that point. This worked great, but it had negative performance effects everywhere the world was referenced from the universe (entity methods). This is not worth it. So instead this makes it so you can optionally create a world with a lazy option and then init it manually in an effect. This is the correct, explicit flow.

world = useMemo(() => createWorld({ lazy: true }), []);

useEffect(() => {
  world.init();
  return () => world.destroy();
}, [world]);

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.

1 participant