-
Notifications
You must be signed in to change notification settings - Fork 6
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
Is @config really MachineConfig? #268
Comments
If I'm correct, then the name of the argument |
Kidna relates to statelyai/xstate#267 |
Also note that I created a bug ticket to enhance xstate docs to make it more explicit on their side: statelyai/docs#280 |
I'd be happy to accept a PR changing the docs to say |
Resolves: #268 There is a bit of a nomenclature mismatch in XState's docs and that is reported here: https://github.com/statelyai/xstate/issues/3165
The README says:
When I look up
MachineConfig
in the xstate docs I will get to: https://xstate.js.org/docs/packages/xstate-fsm/#machine-config which is defined as:Which does not have
actions
key as shown in the@config
examples:So I think what
@config
is actually referring to is MachineOptions. Guessing based on createMachine syntax and knowledge how this fits together. So the docs wording should be changed:The text was updated successfully, but these errors were encountered: