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

[core] Add meta types #4863

Merged
merged 3 commits into from
Apr 24, 2024
Merged

[core] Add meta types #4863

merged 3 commits into from
Apr 24, 2024

Conversation

davidkpiano
Copy link
Member

@davidkpiano davidkpiano commented Apr 22, 2024

Meta objects for state nodes and transitions can now be specified in setup({ types: … }):

const machine = setup({
  types: {
    meta: {} as {
      layout: string;
    }
  }
}).createMachine({
  initial: 'home',
  states: {
    home: {
      meta: {
        layout: 'full' // strongly typed
      }
    }
  }
});

const actor = createActor(machine).start();

actor.getSnapshot().getMeta().home!;
// typed as { layout: string }

Fixes #809

Copy link

changeset-bot bot commented Apr 22, 2024

🦋 Changeset detected

Latest commit: f546669

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
xstate Minor

Not sure what this means? Click here to learn what changesets are.

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

@jonestristand
Copy link

This would be very useful to me!

@davidkpiano
Copy link
Member Author

cc. @Andarist Quick review? 🥺

@davidkpiano davidkpiano merged commit 0696adc into main Apr 24, 2024
1 check passed
@davidkpiano davidkpiano deleted the davidkpiano/meta-types branch April 24, 2024 19:41
@github-actions github-actions bot mentioned this pull request Apr 24, 2024
@jonestristand
Copy link

Amazing, thank you!

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.

[Feature] Enforce/describe State Meta Data with TS
3 participants